samsara_api 0.0.228

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1469) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/lib/environment.rb +10 -0
  4. data/lib/gemconfig.rb +13 -0
  5. data/lib/requests.rb +166 -0
  6. data/lib/samsara_api/addresses/client.rb +596 -0
  7. data/lib/samsara_api/addresses/types/create_address_request_address_types_item.rb +19 -0
  8. data/lib/samsara_api/addresses/types/update_address_request_address_types_item.rb +19 -0
  9. data/lib/samsara_api/alerts/client.rb +38 -0
  10. data/lib/samsara_api/alerts/configurations/client.rb +1270 -0
  11. data/lib/samsara_api/alerts/configurations/types/configurations_list_request_status.rb +17 -0
  12. data/lib/samsara_api/alerts/incidents/client.rb +134 -0
  13. data/lib/samsara_api/assets/client.rb +527 -0
  14. data/lib/samsara_api/assets/location_and_speed/client.rb +168 -0
  15. data/lib/samsara_api/assets/types/assets_create_asset_request_body_regulation_mode.rb +18 -0
  16. data/lib/samsara_api/assets/types/assets_create_asset_request_body_type.rb +22 -0
  17. data/lib/samsara_api/assets/types/assets_list_request_type.rb +17 -0
  18. data/lib/samsara_api/assets/types/assets_update_asset_request_body_regulation_mode.rb +18 -0
  19. data/lib/samsara_api/assets/types/assets_update_asset_request_body_type.rb +22 -0
  20. data/lib/samsara_api/attributes/client.rb +526 -0
  21. data/lib/samsara_api/attributes/types/attributes_delete_request_entity_type.rb +14 -0
  22. data/lib/samsara_api/attributes/types/attributes_get_request_entity_type.rb +14 -0
  23. data/lib/samsara_api/attributes/types/attributes_list_request_entity_type.rb +14 -0
  24. data/lib/samsara_api/attributes/types/create_attribute_request_attribute_type.rb +16 -0
  25. data/lib/samsara_api/attributes/types/create_attribute_request_attribute_value_quantity.rb +16 -0
  26. data/lib/samsara_api/attributes/types/create_attribute_request_entity_type.rb +15 -0
  27. data/lib/samsara_api/attributes/types/update_attribute_request_attribute_type.rb +16 -0
  28. data/lib/samsara_api/attributes/types/update_attribute_request_attribute_value_quantity.rb +17 -0
  29. data/lib/samsara_api/attributes/types/update_attribute_request_entity_type.rb +15 -0
  30. data/lib/samsara_api/auth/client.rb +31 -0
  31. data/lib/samsara_api/auth/tokens/client.rb +153 -0
  32. data/lib/samsara_api/auth/tokens/types/create_tokens_response.rb +88 -0
  33. data/lib/samsara_api/cameras/client.rb +31 -0
  34. data/lib/samsara_api/cameras/media/client.rb +196 -0
  35. data/lib/samsara_api/cameras/media/retrieval/client.rb +278 -0
  36. data/lib/samsara_api/cameras/media/retrieval/types/media_retrieval_post_media_retrieval_request_body_inputs_item.rb +20 -0
  37. data/lib/samsara_api/cameras/media/retrieval/types/media_retrieval_post_media_retrieval_request_body_media_type.rb +22 -0
  38. data/lib/samsara_api/cameras/media/types/media_list_request_inputs_item.rb +17 -0
  39. data/lib/samsara_api/cameras/media/types/media_list_request_media_types_item.rb +16 -0
  40. data/lib/samsara_api/cameras/media/types/media_list_request_trigger_reasons_item.rb +22 -0
  41. data/lib/samsara_api/carrier_proposed_assignments/client.rb +332 -0
  42. data/lib/samsara_api/coaching/client.rb +38 -0
  43. data/lib/samsara_api/coaching/driver_coach_assignments/client.rb +230 -0
  44. data/lib/samsara_api/coaching/sessions/client.rb +166 -0
  45. data/lib/samsara_api/contacts/client.rb +468 -0
  46. data/lib/samsara_api/defect_types/client.rb +126 -0
  47. data/lib/samsara_api/defects/client.rb +441 -0
  48. data/lib/samsara_api/devices/client.rb +150 -0
  49. data/lib/samsara_api/document_types/client.rb +124 -0
  50. data/lib/samsara_api/documents/client.rb +484 -0
  51. data/lib/samsara_api/documents/pdfs/client.rb +198 -0
  52. data/lib/samsara_api/documents/types/documents_post_document_request_body_state.rb +18 -0
  53. data/lib/samsara_api/driver_trailer_assignments/client.rb +310 -0
  54. data/lib/samsara_api/driver_vehicle_assignments/client.rb +545 -0
  55. data/lib/samsara_api/driver_vehicle_assignments/types/driver_vehicle_assignments_get_request_assignment_type.rb +22 -0
  56. data/lib/samsara_api/driver_vehicle_assignments/types/driver_vehicle_assignments_get_request_filter_by.rb +14 -0
  57. data/lib/samsara_api/drivers/client.rb +821 -0
  58. data/lib/samsara_api/drivers/qr_codes/client.rb +295 -0
  59. data/lib/samsara_api/drivers/types/create_driver_request_locale.rb +30 -0
  60. data/lib/samsara_api/drivers/types/drivers_list_request_driver_activation_status.rb +14 -0
  61. data/lib/samsara_api/drivers/types/update_driver_request_driver_activation_status.rb +16 -0
  62. data/lib/samsara_api/drivers/types/update_driver_request_locale.rb +30 -0
  63. data/lib/samsara_api/drivers/vehicle_assignments/client.rb +171 -0
  64. data/lib/samsara_api/drivers/vehicle_assignments/types/vehicle_assignments_list_request_driver_activation_status.rb +16 -0
  65. data/lib/samsara_api/dvirs/client.rb +546 -0
  66. data/lib/samsara_api/dvirs/types/create_dvir_request_safety_status.rb +15 -0
  67. data/lib/samsara_api/equipment/client.rb +208 -0
  68. data/lib/samsara_api/equipment/locations/client.rb +359 -0
  69. data/lib/samsara_api/equipment/stats/client.rb +572 -0
  70. data/lib/samsara_api/equipment/stats/types/stats_feed_request_types_item.rb +24 -0
  71. data/lib/samsara_api/equipment/stats/types/stats_history_request_types_item.rb +24 -0
  72. data/lib/samsara_api/equipment/stats/types/stats_list_request_types_item.rb +24 -0
  73. data/lib/samsara_api/form_submissions/client.rb +550 -0
  74. data/lib/samsara_api/form_submissions/pdf_exports/client.rb +206 -0
  75. data/lib/samsara_api/form_submissions/types/form_submissions_patch_form_submission_request_body_status.rb +19 -0
  76. data/lib/samsara_api/forms/client.rb +126 -0
  77. data/lib/samsara_api/fuel_purchases/client.rb +164 -0
  78. data/lib/samsara_api/fuel_purchases/types/fuel_purchase_post_fuel_purchase_request_body_ifta_fuel_type.rb +32 -0
  79. data/lib/samsara_api/gateways/client.rb +307 -0
  80. data/lib/samsara_api/hos/client.rb +599 -0
  81. data/lib/samsara_api/hos/types/hos_daily_logs_request_driver_activation_status.rb +14 -0
  82. data/lib/samsara_api/idling/client.rb +203 -0
  83. data/lib/samsara_api/idling/types/idling_list_request_pto_state.rb +14 -0
  84. data/lib/samsara_api/ifta/client.rb +31 -0
  85. data/lib/samsara_api/ifta/csv/client.rb +254 -0
  86. data/lib/samsara_api/inputs/client.rb +171 -0
  87. data/lib/samsara_api/inputs/types/inputs_stream_request_type.rb +30 -0
  88. data/lib/samsara_api/issues/client.rb +359 -0
  89. data/lib/samsara_api/issues/types/issues_patch_issue_request_body_status.rb +18 -0
  90. data/lib/samsara_api/legacy/client.rb +160 -0
  91. data/lib/samsara_api/live_shares/client.rb +434 -0
  92. data/lib/samsara_api/live_shares/types/live_shares_list_request_type.rb +16 -0
  93. data/lib/samsara_api/live_shares/types/live_sharing_links_create_live_sharing_link_request_body_type.rb +18 -0
  94. data/lib/samsara_api/maintenance/client.rb +38 -0
  95. data/lib/samsara_api/maintenance/service_tasks/client.rb +297 -0
  96. data/lib/samsara_api/maintenance/work_orders/client.rb +658 -0
  97. data/lib/samsara_api/maintenance/work_orders/types/work_orders_patch_work_orders_request_body_category.rb +22 -0
  98. data/lib/samsara_api/maintenance/work_orders/types/work_orders_patch_work_orders_request_body_priority.rb +19 -0
  99. data/lib/samsara_api/maintenance/work_orders/types/work_orders_patch_work_orders_request_body_status.rb +26 -0
  100. data/lib/samsara_api/maintenance/work_orders/types/work_orders_post_work_orders_request_body_category.rb +22 -0
  101. data/lib/samsara_api/maintenance/work_orders/types/work_orders_post_work_orders_request_body_priority.rb +19 -0
  102. data/lib/samsara_api/maintenance/work_orders/types/work_orders_stream_request_work_order_statuses_item.rb +23 -0
  103. data/lib/samsara_api/me/client.rb +112 -0
  104. data/lib/samsara_api/readings/client.rb +380 -0
  105. data/lib/samsara_api/reports/client.rb +32 -0
  106. data/lib/samsara_api/reports/drivers/client.rb +33 -0
  107. data/lib/samsara_api/reports/drivers/fuel_energy/client.rb +166 -0
  108. data/lib/samsara_api/reports/ifta/client.rb +40 -0
  109. data/lib/samsara_api/reports/ifta/jurisdiction/client.rb +177 -0
  110. data/lib/samsara_api/reports/ifta/jurisdiction/types/jurisdiction_get_request_fuel_type.rb +32 -0
  111. data/lib/samsara_api/reports/ifta/jurisdiction/types/jurisdiction_get_request_month.rb +28 -0
  112. data/lib/samsara_api/reports/ifta/jurisdiction/types/jurisdiction_get_request_quarter.rb +20 -0
  113. data/lib/samsara_api/reports/ifta/vehicle/client.rb +183 -0
  114. data/lib/samsara_api/reports/ifta/vehicle/types/vehicle_list_request_fuel_type.rb +32 -0
  115. data/lib/samsara_api/reports/ifta/vehicle/types/vehicle_list_request_month.rb +28 -0
  116. data/lib/samsara_api/reports/ifta/vehicle/types/vehicle_list_request_quarter.rb +20 -0
  117. data/lib/samsara_api/reports/vehicles/client.rb +40 -0
  118. data/lib/samsara_api/reports/vehicles/fuel_energy/client.rb +171 -0
  119. data/lib/samsara_api/reports/vehicles/fuel_energy/types/fuel_energy_list_request_energy_type.rb +19 -0
  120. data/lib/samsara_api/reports/vehicles/idling/client.rb +176 -0
  121. data/lib/samsara_api/routes/audit_logs/client.rb +138 -0
  122. data/lib/samsara_api/routes/client.rb +691 -0
  123. data/lib/samsara_api/safety_events/audit_logs/client.rb +148 -0
  124. data/lib/samsara_api/safety_events/client.rb +147 -0
  125. data/lib/samsara_api/settings/client.rb +45 -0
  126. data/lib/samsara_api/settings/compliance/client.rb +232 -0
  127. data/lib/samsara_api/settings/driver_app/client.rb +234 -0
  128. data/lib/samsara_api/settings/safety/client.rb +120 -0
  129. data/lib/samsara_api/speeding_intervals/client.rb +155 -0
  130. data/lib/samsara_api/speeding_intervals/types/speeding_intervals_stream_request_query_by.rb +14 -0
  131. data/lib/samsara_api/tachograph/client.rb +38 -0
  132. data/lib/samsara_api/tachograph/driver/client.rb +262 -0
  133. data/lib/samsara_api/tachograph/vehicles/client.rb +148 -0
  134. data/lib/samsara_api/tags/client.rb +651 -0
  135. data/lib/samsara_api/trailers/client.rb +592 -0
  136. data/lib/samsara_api/training_assignments/client.rb +170 -0
  137. data/lib/samsara_api/training_courses/client.rb +148 -0
  138. data/lib/samsara_api/trips/client.rb +150 -0
  139. data/lib/samsara_api/trips/types/trips_stream_request_completion_status.rb +15 -0
  140. data/lib/samsara_api/trips/types/trips_stream_request_query_by.rb +14 -0
  141. data/lib/samsara_api/types/accessory_response_object_response_body.rb +66 -0
  142. data/lib/samsara_api/types/action_object_request_body.rb +86 -0
  143. data/lib/samsara_api/types/action_object_response_body.rb +86 -0
  144. data/lib/samsara_api/types/action_params_object_request_body.rb +91 -0
  145. data/lib/samsara_api/types/action_params_object_response_body.rb +91 -0
  146. data/lib/samsara_api/types/address.rb +171 -0
  147. data/lib/samsara_api/types/address_address_types_item.rb +17 -0
  148. data/lib/samsara_api/types/address_geofence.rb +92 -0
  149. data/lib/samsara_api/types/address_geofence_circle.rb +78 -0
  150. data/lib/samsara_api/types/address_geofence_polygon.rb +63 -0
  151. data/lib/samsara_api/types/address_geofence_polygon_vertices.rb +63 -0
  152. data/lib/samsara_api/types/address_geofence_settings.rb +58 -0
  153. data/lib/samsara_api/types/address_response.rb +60 -0
  154. data/lib/samsara_api/types/address_response_response_body.rb +108 -0
  155. data/lib/samsara_api/types/address_tiny_response.rb +66 -0
  156. data/lib/samsara_api/types/advanced_idling_get_idling_events_response_body.rb +75 -0
  157. data/lib/samsara_api/types/alert_event.rb +147 -0
  158. data/lib/samsara_api/types/alert_event_alert_condition_id.rb +42 -0
  159. data/lib/samsara_api/types/alert_event_device.rb +79 -0
  160. data/lib/samsara_api/types/alert_event_driver.rb +65 -0
  161. data/lib/samsara_api/types/alert_event_dvir.rb +132 -0
  162. data/lib/samsara_api/types/alert_event_dvir_defects_item.rb +84 -0
  163. data/lib/samsara_api/types/alert_event_dvir_driver.rb +65 -0
  164. data/lib/samsara_api/types/alert_event_dvir_inspection_type.rb +14 -0
  165. data/lib/samsara_api/types/alert_event_dvir_safety_status.rb +12 -0
  166. data/lib/samsara_api/types/alert_event_dvir_trailer.rb +65 -0
  167. data/lib/samsara_api/types/alert_event_dvir_vehicle.rb +65 -0
  168. data/lib/samsara_api/types/alert_object_asset_response_body.rb +122 -0
  169. data/lib/samsara_api/types/alert_object_asset_response_body_type.rb +20 -0
  170. data/lib/samsara_api/types/alert_object_driver_response_body.rb +99 -0
  171. data/lib/samsara_api/types/alert_object_machine_input_response_body.rb +66 -0
  172. data/lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb +96 -0
  173. data/lib/samsara_api/types/alert_object_product_response_body.rb +56 -0
  174. data/lib/samsara_api/types/alert_object_sensor_response_body.rb +101 -0
  175. data/lib/samsara_api/types/alert_object_sites_response_body.rb +81 -0
  176. data/lib/samsara_api/types/alert_object_trailer_response_body.rb +114 -0
  177. data/lib/samsara_api/types/alert_object_vehicle_response_body.rb +119 -0
  178. data/lib/samsara_api/types/alert_object_workforce_camera_device_response_body.rb +94 -0
  179. data/lib/samsara_api/types/alerts_get_configurations_response_body.rb +73 -0
  180. data/lib/samsara_api/types/alerts_get_incidents_response_body.rb +73 -0
  181. data/lib/samsara_api/types/alerts_patch_configurations_response_body.rb +60 -0
  182. data/lib/samsara_api/types/alerts_post_configurations_response_body.rb +59 -0
  183. data/lib/samsara_api/types/ambient_temperature_details_object_request_body.rb +92 -0
  184. data/lib/samsara_api/types/ambient_temperature_details_object_request_body_operation.rb +16 -0
  185. data/lib/samsara_api/types/ambient_temperature_details_object_response_body.rb +92 -0
  186. data/lib/samsara_api/types/ambient_temperature_details_object_response_body_operation.rb +16 -0
  187. data/lib/samsara_api/types/ambient_temperature_response_body.rb +62 -0
  188. data/lib/samsara_api/types/asset_response_body.rb +193 -0
  189. data/lib/samsara_api/types/asset_response_body_regulation_mode.rb +16 -0
  190. data/lib/samsara_api/types/asset_response_body_type.rb +20 -0
  191. data/lib/samsara_api/types/asset_response_response_body.rb +66 -0
  192. data/lib/samsara_api/types/assets_create_asset_response_body.rb +59 -0
  193. data/lib/samsara_api/types/assets_inputs_asset_response_response_body.rb +93 -0
  194. data/lib/samsara_api/types/assets_inputs_aux_input_response_body.rb +54 -0
  195. data/lib/samsara_api/types/assets_inputs_get_assets_inputs_response_body.rb +75 -0
  196. data/lib/samsara_api/types/assets_inputs_response_response_body.rb +102 -0
  197. data/lib/samsara_api/types/assets_inputs_response_response_body_units.rb +15 -0
  198. data/lib/samsara_api/types/assets_list_assets_response_body.rb +73 -0
  199. data/lib/samsara_api/types/assets_location_link_config_address_details_object.rb +81 -0
  200. data/lib/samsara_api/types/assets_location_link_config_address_details_object_response_body.rb +81 -0
  201. data/lib/samsara_api/types/assets_location_link_config_object.rb +72 -0
  202. data/lib/samsara_api/types/assets_location_link_config_object_response_body.rb +74 -0
  203. data/lib/samsara_api/types/assets_near_location_link_config_object.rb +56 -0
  204. data/lib/samsara_api/types/assets_near_location_link_config_object_response_body.rb +58 -0
  205. data/lib/samsara_api/types/assets_on_route_link_config_object.rb +54 -0
  206. data/lib/samsara_api/types/assets_on_route_link_config_object_response_body.rb +56 -0
  207. data/lib/samsara_api/types/assets_update_asset_response_body.rb +59 -0
  208. data/lib/samsara_api/types/attribute.rb +118 -0
  209. data/lib/samsara_api/types/attribute_attribute_type.rb +14 -0
  210. data/lib/samsara_api/types/attribute_attribute_value_quantity.rb +14 -0
  211. data/lib/samsara_api/types/attribute_entity.rb +105 -0
  212. data/lib/samsara_api/types/attribute_entity_external_ids.rb +48 -0
  213. data/lib/samsara_api/types/attribute_entity_type.rb +13 -0
  214. data/lib/samsara_api/types/attribute_expanded.rb +129 -0
  215. data/lib/samsara_api/types/attribute_expanded_all_of.rb +57 -0
  216. data/lib/samsara_api/types/attribute_expanded_response.rb +61 -0
  217. data/lib/samsara_api/types/attribute_tiny.rb +80 -0
  218. data/lib/samsara_api/types/attribute_value_tiny.rb +66 -0
  219. data/lib/samsara_api/types/author_signature_object_response_body.rb +80 -0
  220. data/lib/samsara_api/types/author_signature_object_response_body_type.rb +14 -0
  221. data/lib/samsara_api/types/bad_gateway_error_response_body.rb +64 -0
  222. data/lib/samsara_api/types/barcode_value_object_request_body.rb +65 -0
  223. data/lib/samsara_api/types/barcode_value_object_response_body.rb +65 -0
  224. data/lib/samsara_api/types/base_route_response_object_response_body.rb +203 -0
  225. data/lib/samsara_api/types/behavior_response_body.rb +145 -0
  226. data/lib/samsara_api/types/behavior_response_body_coachable_behavior_type.rb +64 -0
  227. data/lib/samsara_api/types/camera_connector_disconected_response_body.rb +92 -0
  228. data/lib/samsara_api/types/camera_details_response_response_body.rb +82 -0
  229. data/lib/samsara_api/types/camera_stream_issue_response_body.rb +62 -0
  230. data/lib/samsara_api/types/carrier_proposed_assignment.rb +131 -0
  231. data/lib/samsara_api/types/carrier_proposed_assignment_driver.rb +73 -0
  232. data/lib/samsara_api/types/carrier_proposed_assignment_driver_all_of.rb +56 -0
  233. data/lib/samsara_api/types/carrier_proposed_assignment_driver_all_of_2_external_ids.rb +7 -0
  234. data/lib/samsara_api/types/carrier_proposed_assignment_response.rb +60 -0
  235. data/lib/samsara_api/types/carrier_proposed_assignment_trailer.rb +73 -0
  236. data/lib/samsara_api/types/carrier_proposed_assignment_trailers.rb +8 -0
  237. data/lib/samsara_api/types/carrier_proposed_assignment_vehicle.rb +74 -0
  238. data/lib/samsara_api/types/cell_connectivity_response_response_body.rb +69 -0
  239. data/lib/samsara_api/types/cell_connectivity_response_response_body_signal_bar.rb +17 -0
  240. data/lib/samsara_api/types/cell_signal_loss_details_object_request_body.rb +55 -0
  241. data/lib/samsara_api/types/cell_signal_loss_details_object_response_body.rb +56 -0
  242. data/lib/samsara_api/types/cell_signal_loss_response_body.rb +91 -0
  243. data/lib/samsara_api/types/circle_request_body.rb +83 -0
  244. data/lib/samsara_api/types/circle_response_body.rb +83 -0
  245. data/lib/samsara_api/types/cloud_backup_upload_issue_response_body.rb +91 -0
  246. data/lib/samsara_api/types/coach_assignment_with_driver_external_ids_response_response_body.rb +96 -0
  247. data/lib/samsara_api/types/coach_assignment_without_driver_external_ids_response_response_body.rb +94 -0
  248. data/lib/samsara_api/types/coachable_event_response_body.rb +54 -0
  249. data/lib/samsara_api/types/coaching_sessions_get_coaching_sessions_response_body.rb +75 -0
  250. data/lib/samsara_api/types/coaching_sessions_response_response_body.rb +166 -0
  251. data/lib/samsara_api/types/coaching_sessions_response_response_body_coaching_type.rb +17 -0
  252. data/lib/samsara_api/types/coaching_sessions_response_response_body_session_status.rb +16 -0
  253. data/lib/samsara_api/types/conditional_field_section_object_response_body.rb +87 -0
  254. data/lib/samsara_api/types/connection_status_response_object_response_body.rb +89 -0
  255. data/lib/samsara_api/types/connection_status_response_object_response_body_health_status.rb +45 -0
  256. data/lib/samsara_api/types/contact.rb +85 -0
  257. data/lib/samsara_api/types/contact_response.rb +62 -0
  258. data/lib/samsara_api/types/contact_tiny_response.rb +73 -0
  259. data/lib/samsara_api/types/continuous_reading_alert_threshold_response_body.rb +106 -0
  260. data/lib/samsara_api/types/continuous_reading_alert_threshold_response_body_operation.rb +16 -0
  261. data/lib/samsara_api/types/continuous_reading_alert_threshold_response_body_unit.rb +74 -0
  262. data/lib/samsara_api/types/create_address_request_geofence.rb +92 -0
  263. data/lib/samsara_api/types/create_address_request_geofence_settings.rb +58 -0
  264. data/lib/samsara_api/types/create_attribute_request_entities.rb +81 -0
  265. data/lib/samsara_api/types/create_driver_request_attributes.rb +80 -0
  266. data/lib/samsara_api/types/create_routes_stop_request_object_request_body.rb +144 -0
  267. data/lib/samsara_api/types/create_user_request_roles.rb +71 -0
  268. data/lib/samsara_api/types/current_duty_status.rb +63 -0
  269. data/lib/samsara_api/types/current_duty_status_hos_status_type.rb +20 -0
  270. data/lib/samsara_api/types/custom_headers_object_request_body.rb +66 -0
  271. data/lib/samsara_api/types/custom_headers_object_response_body.rb +66 -0
  272. data/lib/samsara_api/types/dashcam_disconnected_response_body.rb +91 -0
  273. data/lib/samsara_api/types/data_input_value_response_body.rb +62 -0
  274. data/lib/samsara_api/types/data_usage_response_object_response_body.rb +67 -0
  275. data/lib/samsara_api/types/date_time_value_object_request_body.rb +61 -0
  276. data/lib/samsara_api/types/date_time_value_object_response_body.rb +61 -0
  277. data/lib/samsara_api/types/def_level_trigger_details_object_request_body.rb +74 -0
  278. data/lib/samsara_api/types/def_level_trigger_details_object_request_body_operation.rb +13 -0
  279. data/lib/samsara_api/types/def_level_trigger_details_object_response_body.rb +74 -0
  280. data/lib/samsara_api/types/def_level_trigger_details_object_response_body_operation.rb +13 -0
  281. data/lib/samsara_api/types/defect.rb +152 -0
  282. data/lib/samsara_api/types/defect_photo_response_response_body.rb +66 -0
  283. data/lib/samsara_api/types/defect_resolved_by.rb +79 -0
  284. data/lib/samsara_api/types/defect_resolved_by_type.rb +13 -0
  285. data/lib/samsara_api/types/defect_response.rb +62 -0
  286. data/lib/samsara_api/types/defect_trailer.rb +65 -0
  287. data/lib/samsara_api/types/defect_trailer_response_response_body.rb +66 -0
  288. data/lib/samsara_api/types/defect_types_response_data_response_body.rb +83 -0
  289. data/lib/samsara_api/types/defect_types_response_data_response_body_section_type.rb +20 -0
  290. data/lib/samsara_api/types/defect_vehicle.rb +74 -0
  291. data/lib/samsara_api/types/defect_vehicle_response_response_body.rb +66 -0
  292. data/lib/samsara_api/types/defects_response.rb +76 -0
  293. data/lib/samsara_api/types/defects_response_data_response_body.rb +167 -0
  294. data/lib/samsara_api/types/device_asset_response_response_body.rb +72 -0
  295. data/lib/samsara_api/types/device_movement_data_response_body.rb +91 -0
  296. data/lib/samsara_api/types/device_movement_stopped_data_response_body.rb +92 -0
  297. data/lib/samsara_api/types/device_movement_trigger_details_object_request_body.rb +56 -0
  298. data/lib/samsara_api/types/device_movement_trigger_details_object_response_body.rb +56 -0
  299. data/lib/samsara_api/types/device_response_response_body.rb +127 -0
  300. data/lib/samsara_api/types/device_response_response_body_model.rb +44 -0
  301. data/lib/samsara_api/types/devices_get_devices_response_body.rb +73 -0
  302. data/lib/samsara_api/types/distance_traveled_object_response_body.rb +73 -0
  303. data/lib/samsara_api/types/distracted_driving_detection_alert_settings_object_response_body.rb +91 -0
  304. data/lib/samsara_api/types/document_pdf_generation_response.rb +62 -0
  305. data/lib/samsara_api/types/document_pdf_generation_response_data.rb +65 -0
  306. data/lib/samsara_api/types/document_pdf_query_response.rb +62 -0
  307. data/lib/samsara_api/types/document_pdf_query_response_data.rb +96 -0
  308. data/lib/samsara_api/types/document_pdf_query_response_data_job_status.rb +15 -0
  309. data/lib/samsara_api/types/document_response_object_response_body.rb +202 -0
  310. data/lib/samsara_api/types/document_response_object_response_body_state.rb +19 -0
  311. data/lib/samsara_api/types/document_types_get_document_types_response_body.rb +75 -0
  312. data/lib/samsara_api/types/documents_get_document_response_body.rb +61 -0
  313. data/lib/samsara_api/types/documents_get_documents_response_body.rb +73 -0
  314. data/lib/samsara_api/types/documents_post_document_response_body.rb +61 -0
  315. data/lib/samsara_api/types/driver.rb +330 -0
  316. data/lib/samsara_api/types/driver_activation_status.rb +14 -0
  317. data/lib/samsara_api/types/driver_app_notification_object_request_body.rb +79 -0
  318. data/lib/samsara_api/types/driver_app_notification_object_response_body.rb +80 -0
  319. data/lib/samsara_api/types/driver_app_settings_gamification_config_tiny_object_request_body.rb +60 -0
  320. data/lib/samsara_api/types/driver_app_settings_gamification_config_tiny_object_response_body.rb +60 -0
  321. data/lib/samsara_api/types/driver_app_settings_response_object_response_body.rb +115 -0
  322. data/lib/samsara_api/types/driver_app_settings_trailer_selection_config_tiny_object_request_body.rb +77 -0
  323. data/lib/samsara_api/types/driver_app_settings_trailer_selection_config_tiny_object_response_body.rb +77 -0
  324. data/lib/samsara_api/types/driver_app_sign_in_response_body.rb +62 -0
  325. data/lib/samsara_api/types/driver_app_sign_out_response_body.rb +62 -0
  326. data/lib/samsara_api/types/driver_assignment_metadata_tiny_object_response_body.rb +58 -0
  327. data/lib/samsara_api/types/driver_assignment_object_response_body.rb +108 -0
  328. data/lib/samsara_api/types/driver_carrier_settings.rb +95 -0
  329. data/lib/samsara_api/types/driver_coach_assignments_get_driver_coach_assignment_response_body.rb +75 -0
  330. data/lib/samsara_api/types/driver_coach_assignments_put_driver_coach_assignment_response_body.rb +61 -0
  331. data/lib/samsara_api/types/driver_document_submitted_details_object_request_body.rb +56 -0
  332. data/lib/samsara_api/types/driver_document_submitted_details_object_response_body.rb +56 -0
  333. data/lib/samsara_api/types/driver_document_submitted_response_body.rb +62 -0
  334. data/lib/samsara_api/types/driver_eld_ruleset.rb +91 -0
  335. data/lib/samsara_api/types/driver_eld_ruleset_cycle.rb +44 -0
  336. data/lib/samsara_api/types/driver_eld_ruleset_rest_break.rb +14 -0
  337. data/lib/samsara_api/types/driver_eld_ruleset_restart.rb +17 -0
  338. data/lib/samsara_api/types/driver_eld_ruleset_shift.rb +15 -0
  339. data/lib/samsara_api/types/driver_eld_rulesets.rb +8 -0
  340. data/lib/samsara_api/types/driver_eld_settings.rb +60 -0
  341. data/lib/samsara_api/types/driver_external_ids.rb +7 -0
  342. data/lib/samsara_api/types/driver_hos_setting.rb +56 -0
  343. data/lib/samsara_api/types/driver_locale.rb +28 -0
  344. data/lib/samsara_api/types/driver_message_received_response_body.rb +62 -0
  345. data/lib/samsara_api/types/driver_message_sent_response_body.rb +62 -0
  346. data/lib/samsara_api/types/driver_object_response_body.rb +67 -0
  347. data/lib/samsara_api/types/driver_qr_codes_create_driver_qr_code_response_body.rb +61 -0
  348. data/lib/samsara_api/types/driver_qr_codes_get_drivers_qr_codes_response_body.rb +59 -0
  349. data/lib/samsara_api/types/driver_recorded_response_body.rb +78 -0
  350. data/lib/samsara_api/types/driver_remote_signout_post_driver_remote_signout_response_body.rb +57 -0
  351. data/lib/samsara_api/types/driver_response.rb +62 -0
  352. data/lib/samsara_api/types/driver_ruleset_object_response_body.rb +116 -0
  353. data/lib/samsara_api/types/driver_ruleset_object_response_body_break.rb +14 -0
  354. data/lib/samsara_api/types/driver_ruleset_object_response_body_cycle.rb +44 -0
  355. data/lib/samsara_api/types/driver_ruleset_object_response_body_restart.rb +16 -0
  356. data/lib/samsara_api/types/driver_ruleset_object_response_body_shift.rb +14 -0
  357. data/lib/samsara_api/types/driver_static_assigned_vehicle.rb +66 -0
  358. data/lib/samsara_api/types/driver_tachograph_activity_data.rb +8 -0
  359. data/lib/samsara_api/types/driver_tachograph_activity_response.rb +76 -0
  360. data/lib/samsara_api/types/driver_tags.rb +8 -0
  361. data/lib/samsara_api/types/driver_tiny_response.rb +66 -0
  362. data/lib/samsara_api/types/driver_vehicle_assignment_v_2_object_response_body.rb +145 -0
  363. data/lib/samsara_api/types/driver_vehicle_assignment_v_2_object_response_body_assignment_type.rb +25 -0
  364. data/lib/samsara_api/types/driver_vehicle_assignments_v_2_create_driver_vehicle_assignment_response_body.rb +62 -0
  365. data/lib/samsara_api/types/driver_vehicle_assignments_v_2_get_driver_vehicle_assignments_response_body.rb +76 -0
  366. data/lib/samsara_api/types/driver_vehicle_assignments_v_2_update_driver_vehicle_assignment_response_body.rb +62 -0
  367. data/lib/samsara_api/types/driver_vehicle_group_tag.rb +75 -0
  368. data/lib/samsara_api/types/driver_with_external_id_object_response_body.rb +67 -0
  369. data/lib/samsara_api/types/driver_with_timezone_eld_settings_object_response_body.rb +105 -0
  370. data/lib/samsara_api/types/drivers_vehicle_assignments_get_drivers_vehicle_assignments_response_body.rb +76 -0
  371. data/lib/samsara_api/types/drivers_vehicle_assignments_object_response_body.rb +95 -0
  372. data/lib/samsara_api/types/drivers_vehicle_assignments_object_response_body_driver_activation_status.rb +14 -0
  373. data/lib/samsara_api/types/duty_status_duration_object_response_body.rb +114 -0
  374. data/lib/samsara_api/types/dvir.rb +221 -0
  375. data/lib/samsara_api/types/dvir_author_signature.rb +83 -0
  376. data/lib/samsara_api/types/dvir_defect_get_defect_response_body.rb +166 -0
  377. data/lib/samsara_api/types/dvir_defect_stream_defects_response_body.rb +73 -0
  378. data/lib/samsara_api/types/dvir_defect_type_get_defect_types_response_body.rb +75 -0
  379. data/lib/samsara_api/types/dvir_defects_object_v_20220913_response_body.rb +150 -0
  380. data/lib/samsara_api/types/dvir_get_dvir_response_body.rb +201 -0
  381. data/lib/samsara_api/types/dvir_get_dvir_response_body_safety_status.rb +16 -0
  382. data/lib/samsara_api/types/dvir_get_dvir_response_body_type.rb +16 -0
  383. data/lib/samsara_api/types/dvir_get_dvirs_response_body.rb +73 -0
  384. data/lib/samsara_api/types/dvir_resolved_by_object_response_body.rb +78 -0
  385. data/lib/samsara_api/types/dvir_resolved_by_object_response_body_type.rb +14 -0
  386. data/lib/samsara_api/types/dvir_response.rb +62 -0
  387. data/lib/samsara_api/types/dvir_safety_status.rb +15 -0
  388. data/lib/samsara_api/types/dvir_second_signature.rb +83 -0
  389. data/lib/samsara_api/types/dvir_signature.rb +84 -0
  390. data/lib/samsara_api/types/dvir_signature_signatory_user.rb +65 -0
  391. data/lib/samsara_api/types/dvir_signature_type.rb +14 -0
  392. data/lib/samsara_api/types/dvir_stream_response_data_response_body.rb +201 -0
  393. data/lib/samsara_api/types/dvir_stream_response_data_response_body_safety_status.rb +16 -0
  394. data/lib/samsara_api/types/dvir_stream_response_data_response_body_type.rb +16 -0
  395. data/lib/samsara_api/types/dvir_submitted_device_trigger_details_object_request_body.rb +71 -0
  396. data/lib/samsara_api/types/dvir_submitted_device_trigger_details_object_request_body_dvir_submission_types_item.rb +15 -0
  397. data/lib/samsara_api/types/dvir_submitted_device_trigger_details_object_response_body.rb +71 -0
  398. data/lib/samsara_api/types/dvir_submitted_device_trigger_details_object_response_body_dvir_submission_types_item.rb +15 -0
  399. data/lib/samsara_api/types/dvir_third_signature.rb +83 -0
  400. data/lib/samsara_api/types/dvir_trailer.rb +65 -0
  401. data/lib/samsara_api/types/dvir_trailer_defects.rb +8 -0
  402. data/lib/samsara_api/types/dvir_trailer_defects_items.rb +152 -0
  403. data/lib/samsara_api/types/dvir_trailer_defects_items_trailer.rb +65 -0
  404. data/lib/samsara_api/types/dvir_trailer_defects_items_vehicle.rb +74 -0
  405. data/lib/samsara_api/types/dvir_type.rb +16 -0
  406. data/lib/samsara_api/types/dvir_vehicle.rb +74 -0
  407. data/lib/samsara_api/types/dvir_vehicle_defects.rb +8 -0
  408. data/lib/samsara_api/types/dvirs_list_response.rb +74 -0
  409. data/lib/samsara_api/types/eld_settings_object_response_body.rb +60 -0
  410. data/lib/samsara_api/types/engine_idle_data_response_body.rb +78 -0
  411. data/lib/samsara_api/types/engine_idle_trigger_details_object_request_body.rb +56 -0
  412. data/lib/samsara_api/types/engine_idle_trigger_details_object_response_body.rb +56 -0
  413. data/lib/samsara_api/types/engine_immobilizer_get_engine_immobilizer_states_response_body.rb +75 -0
  414. data/lib/samsara_api/types/engine_immobilizer_relay_state_response_body.rb +67 -0
  415. data/lib/samsara_api/types/engine_immobilizer_relay_state_response_body_id.rb +13 -0
  416. data/lib/samsara_api/types/engine_immobilizer_state_response_body.rb +86 -0
  417. data/lib/samsara_api/types/engine_off_details_object_request_body.rb +54 -0
  418. data/lib/samsara_api/types/engine_off_details_object_response_body.rb +54 -0
  419. data/lib/samsara_api/types/engine_off_response_body.rb +91 -0
  420. data/lib/samsara_api/types/engine_on_details_object_request_body.rb +54 -0
  421. data/lib/samsara_api/types/engine_on_details_object_response_body.rb +54 -0
  422. data/lib/samsara_api/types/engine_on_response_body.rb +91 -0
  423. data/lib/samsara_api/types/enum_reading_alert_threshold_response_body.rb +67 -0
  424. data/lib/samsara_api/types/enum_value_response_body.rb +66 -0
  425. data/lib/samsara_api/types/equipment_engine_rpm.rb +64 -0
  426. data/lib/samsara_api/types/equipment_engine_seconds.rb +68 -0
  427. data/lib/samsara_api/types/equipment_engine_state.rb +67 -0
  428. data/lib/samsara_api/types/equipment_engine_state_value.rb +14 -0
  429. data/lib/samsara_api/types/equipment_engine_total_idle_time_minutes.rb +68 -0
  430. data/lib/samsara_api/types/equipment_fuel_percent.rb +64 -0
  431. data/lib/samsara_api/types/equipment_gateway_engine_seconds.rb +74 -0
  432. data/lib/samsara_api/types/equipment_gateway_engine_state.rb +67 -0
  433. data/lib/samsara_api/types/equipment_gateway_engine_state_value.rb +14 -0
  434. data/lib/samsara_api/types/equipment_gateway_j_1939_engine_seconds.rb +72 -0
  435. data/lib/samsara_api/types/equipment_gps_odometer_meters.rb +68 -0
  436. data/lib/samsara_api/types/equipment_installed_gateway.rb +65 -0
  437. data/lib/samsara_api/types/equipment_list_response.rb +74 -0
  438. data/lib/samsara_api/types/equipment_location.rb +87 -0
  439. data/lib/samsara_api/types/equipment_locations_list_response.rb +74 -0
  440. data/lib/samsara_api/types/equipment_locations_list_response_data.rb +75 -0
  441. data/lib/samsara_api/types/equipment_locations_response.rb +74 -0
  442. data/lib/samsara_api/types/equipment_locations_response_data.rb +77 -0
  443. data/lib/samsara_api/types/equipment_obd_engine_seconds.rb +68 -0
  444. data/lib/samsara_api/types/equipment_obd_engine_state.rb +67 -0
  445. data/lib/samsara_api/types/equipment_obd_engine_state_value.rb +15 -0
  446. data/lib/samsara_api/types/equipment_object.rb +112 -0
  447. data/lib/samsara_api/types/equipment_response.rb +60 -0
  448. data/lib/samsara_api/types/equipment_stats_gps.rb +113 -0
  449. data/lib/samsara_api/types/equipment_stats_list_response.rb +74 -0
  450. data/lib/samsara_api/types/equipment_stats_list_response_data.rb +210 -0
  451. data/lib/samsara_api/types/equipment_stats_response.rb +76 -0
  452. data/lib/samsara_api/types/equipment_stats_response_data.rb +209 -0
  453. data/lib/samsara_api/types/event_location_response_body.rb +66 -0
  454. data/lib/samsara_api/types/external_ids.rb +8 -0
  455. data/lib/samsara_api/types/field_object_post_request_body.rb +81 -0
  456. data/lib/samsara_api/types/field_object_post_request_body_type.rb +20 -0
  457. data/lib/samsara_api/types/field_object_response_body.rb +79 -0
  458. data/lib/samsara_api/types/field_object_response_body_type.rb +20 -0
  459. data/lib/samsara_api/types/field_object_value_request_body.rb +136 -0
  460. data/lib/samsara_api/types/field_object_value_response_body.rb +136 -0
  461. data/lib/samsara_api/types/field_types_object_response_body.rb +114 -0
  462. data/lib/samsara_api/types/field_types_object_response_body_field_type.rb +21 -0
  463. data/lib/samsara_api/types/following_distance_detection_alert_settings_object_response_body.rb +84 -0
  464. data/lib/samsara_api/types/form_submission_pdf_export_response_object_response_body.rb +154 -0
  465. data/lib/samsara_api/types/form_submission_pdf_export_response_object_response_body_job_status.rb +16 -0
  466. data/lib/samsara_api/types/form_submission_request_approval_details_request_body.rb +62 -0
  467. data/lib/samsara_api/types/form_submission_request_asset_object_request_body.rb +56 -0
  468. data/lib/samsara_api/types/form_submission_request_asset_value_object_request_body.rb +62 -0
  469. data/lib/samsara_api/types/form_submission_request_assigned_to_request_body.rb +67 -0
  470. data/lib/samsara_api/types/form_submission_request_assigned_to_request_body_type.rb +13 -0
  471. data/lib/samsara_api/types/form_submission_request_check_boxes_value_object_request_body.rb +57 -0
  472. data/lib/samsara_api/types/form_submission_request_date_time_value_object_request_body.rb +64 -0
  473. data/lib/samsara_api/types/form_submission_request_field_input_object_request_body.rb +188 -0
  474. data/lib/samsara_api/types/form_submission_request_field_input_object_request_body_type.rb +21 -0
  475. data/lib/samsara_api/types/form_submission_request_geofence_object_request_body.rb +56 -0
  476. data/lib/samsara_api/types/form_submission_request_geofence_value_object_request_body.rb +63 -0
  477. data/lib/samsara_api/types/form_submission_request_multiple_choice_value_object_request_body.rb +57 -0
  478. data/lib/samsara_api/types/form_submission_request_number_value_object_request_body.rb +56 -0
  479. data/lib/samsara_api/types/form_submission_request_person_object_request_body.rb +56 -0
  480. data/lib/samsara_api/types/form_submission_request_person_value_object_request_body.rb +63 -0
  481. data/lib/samsara_api/types/form_submission_request_table_cell_object_request_body.rb +149 -0
  482. data/lib/samsara_api/types/form_submission_request_table_cell_object_request_body_type.rb +18 -0
  483. data/lib/samsara_api/types/form_submission_request_table_row_object_request_body.rb +70 -0
  484. data/lib/samsara_api/types/form_submission_request_table_value_object_request_body.rb +60 -0
  485. data/lib/samsara_api/types/form_submission_request_text_value_object_request_body.rb +56 -0
  486. data/lib/samsara_api/types/form_submission_response_object_response_body.rb +292 -0
  487. data/lib/samsara_api/types/form_submission_response_object_response_body_status.rb +20 -0
  488. data/lib/samsara_api/types/form_submissions_get_form_submissions_pdf_exports_response_body.rb +61 -0
  489. data/lib/samsara_api/types/form_submissions_get_form_submissions_response_body.rb +59 -0
  490. data/lib/samsara_api/types/form_submissions_get_form_submissions_stream_response_body.rb +75 -0
  491. data/lib/samsara_api/types/form_submissions_patch_form_submission_response_body.rb +61 -0
  492. data/lib/samsara_api/types/form_submissions_post_form_submission_response_body.rb +61 -0
  493. data/lib/samsara_api/types/form_submissions_post_form_submissions_pdf_exports_response_body.rb +61 -0
  494. data/lib/samsara_api/types/form_submitted_response_body.rb +60 -0
  495. data/lib/samsara_api/types/form_template_reference_object_response_body.rb +66 -0
  496. data/lib/samsara_api/types/form_template_request_object_request_body.rb +68 -0
  497. data/lib/samsara_api/types/form_template_response_object_response_body.rb +167 -0
  498. data/lib/samsara_api/types/form_template_section_object_response_body.rb +81 -0
  499. data/lib/samsara_api/types/form_templates_get_form_templates_response_body.rb +75 -0
  500. data/lib/samsara_api/types/forms_action_object_response_body.rb +82 -0
  501. data/lib/samsara_api/types/forms_action_object_response_body_type.rb +18 -0
  502. data/lib/samsara_api/types/forms_approval_config_object_response_body.rb +73 -0
  503. data/lib/samsara_api/types/forms_asset_object_response_body.rb +81 -0
  504. data/lib/samsara_api/types/forms_asset_object_response_body_entry_type.rb +13 -0
  505. data/lib/samsara_api/types/forms_asset_value_object_response_body.rb +60 -0
  506. data/lib/samsara_api/types/forms_check_boxes_value_object_response_body.rb +65 -0
  507. data/lib/samsara_api/types/forms_condition_object_response_body.rb +75 -0
  508. data/lib/samsara_api/types/forms_condition_object_response_body_type.rb +14 -0
  509. data/lib/samsara_api/types/forms_conditional_action_object_response_body.rb +76 -0
  510. data/lib/samsara_api/types/forms_date_time_value_object_response_body.rb +70 -0
  511. data/lib/samsara_api/types/forms_date_time_value_object_response_body_type.rb +14 -0
  512. data/lib/samsara_api/types/forms_field_definition_object_response_body.rb +217 -0
  513. data/lib/samsara_api/types/forms_field_definition_object_response_body_allowed_asset_types_item.rb +15 -0
  514. data/lib/samsara_api/types/forms_field_definition_object_response_body_allowed_date_time_value_type.rb +15 -0
  515. data/lib/samsara_api/types/forms_field_definition_object_response_body_type.rb +26 -0
  516. data/lib/samsara_api/types/forms_field_input_object_response_body.rb +252 -0
  517. data/lib/samsara_api/types/forms_field_input_object_response_body_type.rb +24 -0
  518. data/lib/samsara_api/types/forms_geofence_object_response_body.rb +88 -0
  519. data/lib/samsara_api/types/forms_geofence_object_response_body_entry_type.rb +13 -0
  520. data/lib/samsara_api/types/forms_geofence_value_object_response_body.rb +60 -0
  521. data/lib/samsara_api/types/forms_issue_created_by_field_object_response_body.rb +68 -0
  522. data/lib/samsara_api/types/forms_location_object_response_body.rb +64 -0
  523. data/lib/samsara_api/types/forms_media_record_object_response_body.rb +88 -0
  524. data/lib/samsara_api/types/forms_media_record_object_response_body_processing_status.rb +14 -0
  525. data/lib/samsara_api/types/forms_media_value_object_response_body.rb +58 -0
  526. data/lib/samsara_api/types/forms_multiple_choice_value_object_response_body.rb +66 -0
  527. data/lib/samsara_api/types/forms_number_value_object_response_body.rb +54 -0
  528. data/lib/samsara_api/types/forms_person_object_response_body.rb +80 -0
  529. data/lib/samsara_api/types/forms_person_object_response_body_entry_type.rb +13 -0
  530. data/lib/samsara_api/types/forms_person_value_object_response_body.rb +60 -0
  531. data/lib/samsara_api/types/forms_polymorphic_user_object_response_body.rb +66 -0
  532. data/lib/samsara_api/types/forms_polymorphic_user_object_response_body_type.rb +13 -0
  533. data/lib/samsara_api/types/forms_product_submission_approval_details_object_response_body.rb +56 -0
  534. data/lib/samsara_api/types/forms_score_object_response_body.rb +71 -0
  535. data/lib/samsara_api/types/forms_select_option_object_response_body.rb +86 -0
  536. data/lib/samsara_api/types/forms_signature_value_object_response_body.rb +61 -0
  537. data/lib/samsara_api/types/forms_single_approval_config_object_response_body.rb +72 -0
  538. data/lib/samsara_api/types/forms_table_cell_object_response_body.rb +173 -0
  539. data/lib/samsara_api/types/forms_table_cell_object_response_body_type.rb +20 -0
  540. data/lib/samsara_api/types/forms_table_column_object_response_body.rb +74 -0
  541. data/lib/samsara_api/types/forms_table_column_object_response_body_type.rb +20 -0
  542. data/lib/samsara_api/types/forms_table_field_definition_object_response_body.rb +142 -0
  543. data/lib/samsara_api/types/forms_table_field_definition_object_response_body_allowed_date_time_value_type.rb +15 -0
  544. data/lib/samsara_api/types/forms_table_field_definition_object_response_body_type.rb +20 -0
  545. data/lib/samsara_api/types/forms_table_row_object_response_body.rb +68 -0
  546. data/lib/samsara_api/types/forms_table_value_object_response_body.rb +72 -0
  547. data/lib/samsara_api/types/forms_text_value_object_response_body.rb +54 -0
  548. data/lib/samsara_api/types/forward_collision_detection_alert_settings_object_response_body.rb +81 -0
  549. data/lib/samsara_api/types/forward_collision_detection_alert_settings_object_response_body_sensitivity.rb +15 -0
  550. data/lib/samsara_api/types/fuel_cost_object_response_body.rb +67 -0
  551. data/lib/samsara_api/types/fuel_cost_object_response_body_currency.rb +18 -0
  552. data/lib/samsara_api/types/fuel_energy_cost_response_response_body.rb +64 -0
  553. data/lib/samsara_api/types/fuel_energy_driver_report_data_object_response_body.rb +60 -0
  554. data/lib/samsara_api/types/fuel_energy_driver_report_object_response_body.rb +143 -0
  555. data/lib/samsara_api/types/fuel_energy_get_fuel_energy_driver_reports_response_body.rb +77 -0
  556. data/lib/samsara_api/types/fuel_energy_get_fuel_energy_vehicle_reports_response_body.rb +77 -0
  557. data/lib/samsara_api/types/fuel_energy_vehicle_object_response_body.rb +81 -0
  558. data/lib/samsara_api/types/fuel_energy_vehicle_object_response_body_energy_type.rb +14 -0
  559. data/lib/samsara_api/types/fuel_energy_vehicle_report_data_object_response_body.rb +60 -0
  560. data/lib/samsara_api/types/fuel_energy_vehicle_report_object_response_body.rb +143 -0
  561. data/lib/samsara_api/types/fuel_level_percentage_response_body.rb +91 -0
  562. data/lib/samsara_api/types/fuel_level_trigger_details_object_request_body.rb +73 -0
  563. data/lib/samsara_api/types/fuel_level_trigger_details_object_response_body.rb +73 -0
  564. data/lib/samsara_api/types/fuel_purchase_post_fuel_purchase_response_body.rb +61 -0
  565. data/lib/samsara_api/types/fuel_volume_response_body.rb +64 -0
  566. data/lib/samsara_api/types/fuel_volume_response_body_unit.rb +13 -0
  567. data/lib/samsara_api/types/gaseous_fuel_cost_object_response_body.rb +67 -0
  568. data/lib/samsara_api/types/gaseous_fuel_cost_object_response_body_currency.rb +18 -0
  569. data/lib/samsara_api/types/gateway_asset_response_object_response_body.rb +71 -0
  570. data/lib/samsara_api/types/gateway_details_response_response_body.rb +106 -0
  571. data/lib/samsara_api/types/gateway_details_response_response_body_gateway_battery_state.rb +14 -0
  572. data/lib/samsara_api/types/gateway_disconnected_details_object_request_body.rb +58 -0
  573. data/lib/samsara_api/types/gateway_disconnected_details_object_response_body.rb +58 -0
  574. data/lib/samsara_api/types/gateway_disconnected_response_body.rb +91 -0
  575. data/lib/samsara_api/types/gateway_response_object_response_body.rb +126 -0
  576. data/lib/samsara_api/types/gateway_response_object_response_body_model.rb +59 -0
  577. data/lib/samsara_api/types/gateway_timeout_error_response_body.rb +64 -0
  578. data/lib/samsara_api/types/gateway_tiny.rb +66 -0
  579. data/lib/samsara_api/types/gateway_unplugged_trigger_details_object_request_body.rb +56 -0
  580. data/lib/samsara_api/types/gateway_unplugged_trigger_details_object_response_body.rb +56 -0
  581. data/lib/samsara_api/types/gateway_with_vehicle_tiny_response_response_body.rb +91 -0
  582. data/lib/samsara_api/types/gateway_with_vehicle_tiny_response_response_body_model.rb +59 -0
  583. data/lib/samsara_api/types/gateways_get_gateways_response_body.rb +73 -0
  584. data/lib/samsara_api/types/gateways_post_gateway_response_body.rb +59 -0
  585. data/lib/samsara_api/types/geofence_entry_trigger_details_object_request_body.rb +62 -0
  586. data/lib/samsara_api/types/geofence_entry_trigger_details_object_response_body.rb +62 -0
  587. data/lib/samsara_api/types/geofence_exit_trigger_details_object_request_body.rb +62 -0
  588. data/lib/samsara_api/types/geofence_exit_trigger_details_object_response_body.rb +62 -0
  589. data/lib/samsara_api/types/geofence_response_response_body.rb +66 -0
  590. data/lib/samsara_api/types/get_attributes_by_entity_type_response.rb +75 -0
  591. data/lib/samsara_api/types/get_document_type_response_object_response_body.rb +98 -0
  592. data/lib/samsara_api/types/get_driver_trailer_assignments_response_body_response_body.rb +116 -0
  593. data/lib/samsara_api/types/get_media_retrieval_object_response_body.rb +57 -0
  594. data/lib/samsara_api/types/get_response_workflow_configuration_object_response_body.rb +144 -0
  595. data/lib/samsara_api/types/get_service_tasks_response_body.rb +73 -0
  596. data/lib/samsara_api/types/get_training_courses_response_body.rb +73 -0
  597. data/lib/samsara_api/types/get_vehicles_driver_assignments_response_body.rb +75 -0
  598. data/lib/samsara_api/types/get_work_orders_response_body.rb +73 -0
  599. data/lib/samsara_api/types/get_workflow_incident_response_object_response_body.rb +106 -0
  600. data/lib/samsara_api/types/goa_address_tiny_response_response_body.rb +73 -0
  601. data/lib/samsara_api/types/goa_attribute_tiny_request_body.rb +80 -0
  602. data/lib/samsara_api/types/goa_attribute_tiny_response_body.rb +80 -0
  603. data/lib/samsara_api/types/goa_document_tiny_response_response_body.rb +66 -0
  604. data/lib/samsara_api/types/goa_document_type_tiny_response_response_body.rb +68 -0
  605. data/lib/samsara_api/types/goa_driver_tiny_response_response_body.rb +74 -0
  606. data/lib/samsara_api/types/goa_gateway_tiny_response_response_body.rb +75 -0
  607. data/lib/samsara_api/types/goa_gateway_tiny_response_response_body_model.rb +59 -0
  608. data/lib/samsara_api/types/goa_pagination_response_response_body.rb +70 -0
  609. data/lib/samsara_api/types/goa_pagination_with_tokens_response_response_body.rb +74 -0
  610. data/lib/samsara_api/types/goa_route_stop_tiny_response_response_body.rb +73 -0
  611. data/lib/samsara_api/types/goa_route_tiny_response_response_body.rb +73 -0
  612. data/lib/samsara_api/types/goa_tag_tiny_response_request_body.rb +75 -0
  613. data/lib/samsara_api/types/goa_tag_tiny_response_response_body.rb +75 -0
  614. data/lib/samsara_api/types/goa_trailer_tiny_response_response_body.rb +73 -0
  615. data/lib/samsara_api/types/goa_vehicle_tiny_response_response_body.rb +74 -0
  616. data/lib/samsara_api/types/gps_signal_loss_details_object_request_body.rb +55 -0
  617. data/lib/samsara_api/types/gps_signal_loss_details_object_response_body.rb +55 -0
  618. data/lib/samsara_api/types/gps_signal_loss_response_body.rb +91 -0
  619. data/lib/samsara_api/types/gross_vehicle_weight.rb +68 -0
  620. data/lib/samsara_api/types/gross_vehicle_weight_unit.rb +13 -0
  621. data/lib/samsara_api/types/harsh_accel_sensitivity_g_force_settings_object_response_body.rb +75 -0
  622. data/lib/samsara_api/types/harsh_accel_sensitivity_v_2_settings_object_response_body.rb +84 -0
  623. data/lib/samsara_api/types/harsh_accel_sensitivity_v_2_settings_object_response_body_heavy_duty.rb +18 -0
  624. data/lib/samsara_api/types/harsh_accel_sensitivity_v_2_settings_object_response_body_light_duty.rb +18 -0
  625. data/lib/samsara_api/types/harsh_accel_sensitivity_v_2_settings_object_response_body_passenger.rb +18 -0
  626. data/lib/samsara_api/types/harsh_brake_sensitivity_g_force_settings_object_response_body.rb +75 -0
  627. data/lib/samsara_api/types/harsh_brake_sensitivity_v_2_settings_object_response_body.rb +84 -0
  628. data/lib/samsara_api/types/harsh_brake_sensitivity_v_2_settings_object_response_body_heavy_duty.rb +19 -0
  629. data/lib/samsara_api/types/harsh_brake_sensitivity_v_2_settings_object_response_body_light_duty.rb +19 -0
  630. data/lib/samsara_api/types/harsh_brake_sensitivity_v_2_settings_object_response_body_passenger.rb +19 -0
  631. data/lib/samsara_api/types/harsh_event_data_response_body.rb +78 -0
  632. data/lib/samsara_api/types/harsh_event_sensitivity_settings_object_response_body.rb +95 -0
  633. data/lib/samsara_api/types/harsh_event_sensitivity_v_2_settings_object_response_body.rb +94 -0
  634. data/lib/samsara_api/types/harsh_event_trigger_details_object_request_body.rb +57 -0
  635. data/lib/samsara_api/types/harsh_event_trigger_details_object_request_body_types_item.rb +60 -0
  636. data/lib/samsara_api/types/harsh_event_trigger_details_object_response_body.rb +57 -0
  637. data/lib/samsara_api/types/harsh_event_trigger_details_object_response_body_types_item.rb +60 -0
  638. data/lib/samsara_api/types/harsh_turn_sensitivity_g_force_settings_object_response_body.rb +75 -0
  639. data/lib/samsara_api/types/harsh_turn_sensitivity_v_2_settings_object_response_body.rb +84 -0
  640. data/lib/samsara_api/types/harsh_turn_sensitivity_v_2_settings_object_response_body_heavy_duty.rb +19 -0
  641. data/lib/samsara_api/types/harsh_turn_sensitivity_v_2_settings_object_response_body_light_duty.rb +19 -0
  642. data/lib/samsara_api/types/harsh_turn_sensitivity_v_2_settings_object_response_body_passenger.rb +19 -0
  643. data/lib/samsara_api/types/health_details_response_response_body.rb +78 -0
  644. data/lib/samsara_api/types/health_reason_response_response_body.rb +80 -0
  645. data/lib/samsara_api/types/health_reason_response_response_body_health_reason_code.rb +31 -0
  646. data/lib/samsara_api/types/health_response_response_body.rb +290 -0
  647. data/lib/samsara_api/types/health_response_response_body_health_status.rb +16 -0
  648. data/lib/samsara_api/types/health_response_response_body_primary_health_reason.rb +32 -0
  649. data/lib/samsara_api/types/health_response_response_body_recommended_action.rb +122 -0
  650. data/lib/samsara_api/types/hos_break.rb +56 -0
  651. data/lib/samsara_api/types/hos_clocks.rb +106 -0
  652. data/lib/samsara_api/types/hos_clocks_for_driver.rb +118 -0
  653. data/lib/samsara_api/types/hos_clocks_for_drivers.rb +8 -0
  654. data/lib/samsara_api/types/hos_clocks_response.rb +74 -0
  655. data/lib/samsara_api/types/hos_cycle.rb +83 -0
  656. data/lib/samsara_api/types/hos_daily_logs_get_hos_daily_logs_response_body.rb +75 -0
  657. data/lib/samsara_api/types/hos_daily_logs_object_response_body.rb +134 -0
  658. data/lib/samsara_api/types/hos_drive.rb +60 -0
  659. data/lib/samsara_api/types/hos_log_entry.rb +120 -0
  660. data/lib/samsara_api/types/hos_log_entry_hos_status_type.rb +18 -0
  661. data/lib/samsara_api/types/hos_log_location.rb +64 -0
  662. data/lib/samsara_api/types/hos_logs_for_driver.rb +76 -0
  663. data/lib/samsara_api/types/hos_logs_for_drivers.rb +8 -0
  664. data/lib/samsara_api/types/hos_logs_list.rb +8 -0
  665. data/lib/samsara_api/types/hos_logs_response.rb +74 -0
  666. data/lib/samsara_api/types/hos_shift.rb +60 -0
  667. data/lib/samsara_api/types/hos_violation_data_response_body.rb +62 -0
  668. data/lib/samsara_api/types/hos_violation_day_object_response_body.rb +67 -0
  669. data/lib/samsara_api/types/hos_violation_object_response_body.rb +152 -0
  670. data/lib/samsara_api/types/hos_violation_object_response_body_type.rb +36 -0
  671. data/lib/samsara_api/types/hos_violation_trigger_details_object_request_body.rb +73 -0
  672. data/lib/samsara_api/types/hos_violation_trigger_details_object_request_body_violation.rb +24 -0
  673. data/lib/samsara_api/types/hos_violation_trigger_details_object_response_body.rb +73 -0
  674. data/lib/samsara_api/types/hos_violation_trigger_details_object_response_body_violation.rb +24 -0
  675. data/lib/samsara_api/types/hos_violations.rb +76 -0
  676. data/lib/samsara_api/types/hos_violations_get_hos_violations_response_body.rb +75 -0
  677. data/lib/samsara_api/types/hos_violations_object_response_body.rb +57 -0
  678. data/lib/samsara_api/types/idling_event_object_response_body.rb +168 -0
  679. data/lib/samsara_api/types/idling_event_object_response_body_address_type.rb +21 -0
  680. data/lib/samsara_api/types/idling_report_event_address_response_body.rb +71 -0
  681. data/lib/samsara_api/types/idling_report_event_response_body.rb +111 -0
  682. data/lib/samsara_api/types/idling_reports_get_vehicle_idling_reports_response_body.rb +89 -0
  683. data/lib/samsara_api/types/ifta_create_ifta_detail_job_response_body.rb +59 -0
  684. data/lib/samsara_api/types/ifta_detail_job_args_response_body.rb +75 -0
  685. data/lib/samsara_api/types/ifta_detail_job_output_response_body.rb +89 -0
  686. data/lib/samsara_api/types/ifta_detail_job_response_body.rb +135 -0
  687. data/lib/samsara_api/types/ifta_detail_job_response_body_job_status.rb +17 -0
  688. data/lib/samsara_api/types/ifta_get_ifta_detail_job_response_body.rb +59 -0
  689. data/lib/samsara_api/types/ifta_get_ifta_jurisdiction_reports_response_body.rb +61 -0
  690. data/lib/samsara_api/types/ifta_get_ifta_vehicle_reports_response_body.rb +76 -0
  691. data/lib/samsara_api/types/ifta_jurisdiction_report_data_object_response_body.rb +99 -0
  692. data/lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb +82 -0
  693. data/lib/samsara_api/types/ifta_report_troubleshooting_object_response_body.rb +86 -0
  694. data/lib/samsara_api/types/ifta_vehicle_report_data_object_response_body.rb +99 -0
  695. data/lib/samsara_api/types/ifta_vehicle_report_object_response_body.rb +74 -0
  696. data/lib/samsara_api/types/in_app_notification_options_object_request_body.rb +86 -0
  697. data/lib/samsara_api/types/in_app_notification_options_object_response_body.rb +86 -0
  698. data/lib/samsara_api/types/inactivity_response_body.rb +62 -0
  699. data/lib/samsara_api/types/inattentive_driving_detection_alert_settings_object_response_body.rb +87 -0
  700. data/lib/samsara_api/types/inattentive_driving_detection_alert_settings_object_response_body_severity.rb +16 -0
  701. data/lib/samsara_api/types/inline_response_2005.rb +60 -0
  702. data/lib/samsara_api/types/inline_response_2006.rb +60 -0
  703. data/lib/samsara_api/types/inside_geofence_data_response_body.rb +91 -0
  704. data/lib/samsara_api/types/inside_geofence_trigger_details_object_request_body.rb +72 -0
  705. data/lib/samsara_api/types/inside_geofence_trigger_details_object_response_body.rb +72 -0
  706. data/lib/samsara_api/types/internal_server_error_response_body.rb +64 -0
  707. data/lib/samsara_api/types/issue_created_response_body.rb +60 -0
  708. data/lib/samsara_api/types/issue_response_object_response_body.rb +212 -0
  709. data/lib/samsara_api/types/issue_response_object_response_body_priority.rb +15 -0
  710. data/lib/samsara_api/types/issue_response_object_response_body_status.rb +16 -0
  711. data/lib/samsara_api/types/issue_source_object_response_body.rb +69 -0
  712. data/lib/samsara_api/types/issue_source_object_response_body_type.rb +13 -0
  713. data/lib/samsara_api/types/issues_get_issues_response_body.rb +57 -0
  714. data/lib/samsara_api/types/issues_get_issues_stream_response_body.rb +73 -0
  715. data/lib/samsara_api/types/issues_patch_issue_response_body.rb +59 -0
  716. data/lib/samsara_api/types/jamming_detected_response_body.rb +91 -0
  717. data/lib/samsara_api/types/last_known_location_response_response_body.rb +74 -0
  718. data/lib/samsara_api/types/list_addresses_response.rb +74 -0
  719. data/lib/samsara_api/types/list_carrier_proposed_assignment_response.rb +75 -0
  720. data/lib/samsara_api/types/list_contacts_response.rb +76 -0
  721. data/lib/samsara_api/types/list_drivers_response.rb +76 -0
  722. data/lib/samsara_api/types/list_tags_response.rb +76 -0
  723. data/lib/samsara_api/types/list_uploaded_media_object_response_body.rb +57 -0
  724. data/lib/samsara_api/types/list_user_roles_response.rb +76 -0
  725. data/lib/samsara_api/types/list_users_response.rb +76 -0
  726. data/lib/samsara_api/types/live_sharing_link_full_response_object_response_body.rb +138 -0
  727. data/lib/samsara_api/types/live_sharing_link_full_response_object_response_body_type.rb +15 -0
  728. data/lib/samsara_api/types/live_sharing_link_response_object_response_body.rb +75 -0
  729. data/lib/samsara_api/types/live_sharing_links_create_live_sharing_link_response_body.rb +61 -0
  730. data/lib/samsara_api/types/live_sharing_links_get_live_sharing_links_response_body.rb +75 -0
  731. data/lib/samsara_api/types/live_sharing_links_update_live_sharing_link_response_body.rb +61 -0
  732. data/lib/samsara_api/types/location.rb +64 -0
  733. data/lib/samsara_api/types/location_and_speed_get_location_and_speed_response_body.rb +75 -0
  734. data/lib/samsara_api/types/location_and_speed_response_response_body.rb +98 -0
  735. data/lib/samsara_api/types/location_object_request_body.rb +101 -0
  736. data/lib/samsara_api/types/location_object_request_body_address_types_item.rb +20 -0
  737. data/lib/samsara_api/types/location_object_response_body.rb +101 -0
  738. data/lib/samsara_api/types/location_object_response_body_address_types_item.rb +20 -0
  739. data/lib/samsara_api/types/location_response_response_body.rb +108 -0
  740. data/lib/samsara_api/types/log_meta_data_object_response_body.rb +163 -0
  741. data/lib/samsara_api/types/media_object_response_body.rb +130 -0
  742. data/lib/samsara_api/types/media_object_response_body_input.rb +14 -0
  743. data/lib/samsara_api/types/media_object_response_body_media_type.rb +13 -0
  744. data/lib/samsara_api/types/media_object_response_body_status.rb +15 -0
  745. data/lib/samsara_api/types/media_retrieval_get_media_retrieval_response_body.rb +61 -0
  746. data/lib/samsara_api/types/media_retrieval_list_uploaded_media_response_body.rb +77 -0
  747. data/lib/samsara_api/types/media_retrieval_post_media_retrieval_response_body.rb +61 -0
  748. data/lib/samsara_api/types/method_not_allowed_error_response_body.rb +64 -0
  749. data/lib/samsara_api/types/minimal_route_audit_logs_response_body.rb +65 -0
  750. data/lib/samsara_api/types/minimal_route_stop_audit_logs_response_body.rb +178 -0
  751. data/lib/samsara_api/types/minimal_route_stop_audit_logs_response_body_state.rb +18 -0
  752. data/lib/samsara_api/types/minimal_route_stop_response_body.rb +145 -0
  753. data/lib/samsara_api/types/minimal_route_stop_response_body_state.rb +18 -0
  754. data/lib/samsara_api/types/mobile_usage_detection_alert_settings_object_response_body.rb +75 -0
  755. data/lib/samsara_api/types/motion_detected_response_body.rb +62 -0
  756. data/lib/samsara_api/types/multiple_choice_field_type_meta_data_object_response_body.rb +57 -0
  757. data/lib/samsara_api/types/multiple_choice_value_object_request_body.rb +65 -0
  758. data/lib/samsara_api/types/multiple_choice_value_object_response_body.rb +66 -0
  759. data/lib/samsara_api/types/not_found_error_response_body.rb +64 -0
  760. data/lib/samsara_api/types/not_implemented_error_response_body.rb +64 -0
  761. data/lib/samsara_api/types/number_field_type_meta_data_object_response_body.rb +58 -0
  762. data/lib/samsara_api/types/operational_settings_object_request_body.rb +69 -0
  763. data/lib/samsara_api/types/operational_settings_object_request_body_time_range_type.rb +13 -0
  764. data/lib/samsara_api/types/operational_settings_object_response_body.rb +70 -0
  765. data/lib/samsara_api/types/operational_settings_object_response_body_time_range_type.rb +13 -0
  766. data/lib/samsara_api/types/organization_info_carrier_settings.rb +73 -0
  767. data/lib/samsara_api/types/organization_info_object.rb +79 -0
  768. data/lib/samsara_api/types/organization_info_response.rb +62 -0
  769. data/lib/samsara_api/types/out_of_route_details_object_request_body.rb +66 -0
  770. data/lib/samsara_api/types/out_of_route_details_object_response_body.rb +66 -0
  771. data/lib/samsara_api/types/out_of_route_response_body.rb +91 -0
  772. data/lib/samsara_api/types/outside_geofence_data_response_body.rb +91 -0
  773. data/lib/samsara_api/types/outside_geofence_trigger_details_object_request_body.rb +72 -0
  774. data/lib/samsara_api/types/outside_geofence_trigger_details_object_response_body.rb +72 -0
  775. data/lib/samsara_api/types/pagination_response.rb +70 -0
  776. data/lib/samsara_api/types/panic_button_details_object_request_body.rb +56 -0
  777. data/lib/samsara_api/types/panic_button_details_object_response_body.rb +56 -0
  778. data/lib/samsara_api/types/panic_button_response_body.rb +91 -0
  779. data/lib/samsara_api/types/parent_tag.rb +67 -0
  780. data/lib/samsara_api/types/patch_driver_trailer_assignments_response_body_response_body.rb +103 -0
  781. data/lib/samsara_api/types/patch_driver_vehicle_assignments_v_2_request_body_metadata_request_body.rb +58 -0
  782. data/lib/samsara_api/types/patch_driver_vehicle_assignments_v_2_response_body_response_body.rb +58 -0
  783. data/lib/samsara_api/types/patch_issue_request_body_assigned_to_request_body.rb +66 -0
  784. data/lib/samsara_api/types/patch_response_workflow_configuration_object_response_body.rb +144 -0
  785. data/lib/samsara_api/types/patch_work_orders_response_body.rb +59 -0
  786. data/lib/samsara_api/types/pending_duty_status_durations_object_response_body.rb +117 -0
  787. data/lib/samsara_api/types/person_detected_response_body.rb +62 -0
  788. data/lib/samsara_api/types/photo_value_object_request_body.rb +65 -0
  789. data/lib/samsara_api/types/photo_value_object_response_body.rb +65 -0
  790. data/lib/samsara_api/types/policy_violations_detection_alert_settings_object_response_body.rb +93 -0
  791. data/lib/samsara_api/types/policy_violations_detection_alert_settings_object_response_body_events_available_for_testing_item.rb +18 -0
  792. data/lib/samsara_api/types/policy_violations_detection_alert_settings_object_response_body_events_to_coach_item.rb +20 -0
  793. data/lib/samsara_api/types/polygon_request_body.rb +75 -0
  794. data/lib/samsara_api/types/polygon_response_body.rb +75 -0
  795. data/lib/samsara_api/types/post_driver_trailer_assignments_response_body_response_body.rb +94 -0
  796. data/lib/samsara_api/types/post_driver_vehicle_assignments_v_2_request_body_metadata_request_body.rb +58 -0
  797. data/lib/samsara_api/types/post_driver_vehicle_assignments_v_2_response_body_response_body.rb +58 -0
  798. data/lib/samsara_api/types/post_fuel_purchase_request_body_price_request_body.rb +70 -0
  799. data/lib/samsara_api/types/post_fuel_purchase_request_body_price_request_body_currency.rb +18 -0
  800. data/lib/samsara_api/types/post_fuel_purchase_response_body_response_body.rb +56 -0
  801. data/lib/samsara_api/types/post_media_retrieval_object_response_body.rb +67 -0
  802. data/lib/samsara_api/types/post_response_res_workflow_configuration_object_response_body.rb +144 -0
  803. data/lib/samsara_api/types/post_work_orders_response_body.rb +59 -0
  804. data/lib/samsara_api/types/push_notification_options_object_request_body.rb +56 -0
  805. data/lib/samsara_api/types/push_notification_options_object_response_body.rb +56 -0
  806. data/lib/samsara_api/types/qr_code_response_object_response_body.rb +68 -0
  807. data/lib/samsara_api/types/reading_definition_response_body.rb +113 -0
  808. data/lib/samsara_api/types/reading_history_response_body.rb +80 -0
  809. data/lib/samsara_api/types/reading_snapshot_response_body.rb +87 -0
  810. data/lib/samsara_api/types/reading_trigger_continuous_value_object_request_body.rb +107 -0
  811. data/lib/samsara_api/types/reading_trigger_continuous_value_object_request_body_operation.rb +16 -0
  812. data/lib/samsara_api/types/reading_trigger_continuous_value_object_request_body_unit.rb +74 -0
  813. data/lib/samsara_api/types/reading_trigger_continuous_value_object_response_body.rb +107 -0
  814. data/lib/samsara_api/types/reading_trigger_continuous_value_object_response_body_operation.rb +16 -0
  815. data/lib/samsara_api/types/reading_trigger_continuous_value_object_response_body_unit.rb +74 -0
  816. data/lib/samsara_api/types/reading_trigger_details_object_request_body.rb +101 -0
  817. data/lib/samsara_api/types/reading_trigger_details_object_response_body.rb +102 -0
  818. data/lib/samsara_api/types/reading_trigger_details_response_body.rb +98 -0
  819. data/lib/samsara_api/types/reading_trigger_enum_value_object_request_body.rb +69 -0
  820. data/lib/samsara_api/types/reading_trigger_enum_value_object_response_body.rb +69 -0
  821. data/lib/samsara_api/types/reading_type_response_body.rb +73 -0
  822. data/lib/samsara_api/types/reading_type_response_body_data_type.rb +14 -0
  823. data/lib/samsara_api/types/readings_get_readings_history_response_body.rb +74 -0
  824. data/lib/samsara_api/types/readings_get_readings_snapshot_response_body.rb +75 -0
  825. data/lib/samsara_api/types/readings_list_readings_definitions_response_body.rb +75 -0
  826. data/lib/samsara_api/types/recipient_object_request_body.rb +89 -0
  827. data/lib/samsara_api/types/recipient_object_request_body_notification_types_item.rb +14 -0
  828. data/lib/samsara_api/types/recipient_object_request_body_type.rb +14 -0
  829. data/lib/samsara_api/types/recipient_object_response_body.rb +89 -0
  830. data/lib/samsara_api/types/recipient_object_response_body_notification_types_item.rb +14 -0
  831. data/lib/samsara_api/types/recipient_object_response_body_type.rb +14 -0
  832. data/lib/samsara_api/types/reefer_temperature_response_body.rb +91 -0
  833. data/lib/samsara_api/types/resolved_by.rb +64 -0
  834. data/lib/samsara_api/types/reverse_geo.rb +56 -0
  835. data/lib/samsara_api/types/rolling_stop_detection_alert_settings_object_response_body.rb +69 -0
  836. data/lib/samsara_api/types/route_changes_response_body.rb +75 -0
  837. data/lib/samsara_api/types/route_feed_object_response_body.rb +129 -0
  838. data/lib/samsara_api/types/route_feed_object_response_body_operation.rb +24 -0
  839. data/lib/samsara_api/types/route_feed_object_response_body_source.rb +16 -0
  840. data/lib/samsara_api/types/route_settings_request_body.rb +87 -0
  841. data/lib/samsara_api/types/route_settings_request_body_route_completion_condition.rb +17 -0
  842. data/lib/samsara_api/types/route_settings_request_body_route_starting_condition.rb +18 -0
  843. data/lib/samsara_api/types/route_settings_response_body.rb +87 -0
  844. data/lib/samsara_api/types/route_settings_response_body_route_completion_condition.rb +17 -0
  845. data/lib/samsara_api/types/route_settings_response_body_route_starting_condition.rb +18 -0
  846. data/lib/samsara_api/types/route_stop_details_object_response_body.rb +138 -0
  847. data/lib/samsara_api/types/route_stop_details_object_response_body_operation.rb +14 -0
  848. data/lib/samsara_api/types/route_stop_estimated_arrival_details_object_request_body.rb +92 -0
  849. data/lib/samsara_api/types/route_stop_estimated_arrival_details_object_response_body.rb +92 -0
  850. data/lib/samsara_api/types/route_stop_eta_response_body.rb +91 -0
  851. data/lib/samsara_api/types/routes_create_route_response_body.rb +61 -0
  852. data/lib/samsara_api/types/routes_fetch_route_response_body.rb +61 -0
  853. data/lib/samsara_api/types/routes_fetch_routes_response_body.rb +73 -0
  854. data/lib/samsara_api/types/routes_get_routes_feed_response_body.rb +73 -0
  855. data/lib/samsara_api/types/routes_patch_route_response_body.rb +61 -0
  856. data/lib/samsara_api/types/routes_single_use_address_object_request_body.rb +76 -0
  857. data/lib/samsara_api/types/routes_single_use_address_object_response_body.rb +76 -0
  858. data/lib/samsara_api/types/routes_stop_response_object_response_body.rb +248 -0
  859. data/lib/samsara_api/types/routes_stop_response_object_response_body_state.rb +18 -0
  860. data/lib/samsara_api/types/safety_event.rb +152 -0
  861. data/lib/samsara_api/types/safety_event_activity_feed_item_response_body.rb +97 -0
  862. data/lib/samsara_api/types/safety_event_activity_feed_item_response_body_type.rb +18 -0
  863. data/lib/samsara_api/types/safety_event_behavior_label.rb +75 -0
  864. data/lib/samsara_api/types/safety_event_behavior_label_source.rb +14 -0
  865. data/lib/samsara_api/types/safety_event_behavior_label_type.rb +46 -0
  866. data/lib/samsara_api/types/safety_event_behavior_labels.rb +8 -0
  867. data/lib/samsara_api/types/safety_event_behavior_labels_response_body.rb +84 -0
  868. data/lib/samsara_api/types/safety_event_behavior_labels_response_body_type.rb +53 -0
  869. data/lib/samsara_api/types/safety_event_coaching_state.rb +24 -0
  870. data/lib/samsara_api/types/safety_event_driver_object_response_body.rb +56 -0
  871. data/lib/samsara_api/types/safety_event_object_response_body.rb +103 -0
  872. data/lib/samsara_api/types/safety_event_vehicle_object_response_body.rb +56 -0
  873. data/lib/samsara_api/types/safety_events_get_safety_activity_event_feed_response_body.rb +75 -0
  874. data/lib/samsara_api/types/safety_events_list_response.rb +76 -0
  875. data/lib/samsara_api/types/safety_score_configuration_settings_object_response_body.rb +266 -0
  876. data/lib/samsara_api/types/safety_settings_get_safety_settings_response_body.rb +59 -0
  877. data/lib/samsara_api/types/safety_settings_object_response_body.rb +199 -0
  878. data/lib/samsara_api/types/safety_settings_object_response_body_default_vehicle_type.rb +17 -0
  879. data/lib/samsara_api/types/scanned_document_value_object_request_body.rb +66 -0
  880. data/lib/samsara_api/types/scanned_document_value_object_response_body.rb +66 -0
  881. data/lib/samsara_api/types/scheduled_maintenance_by_engine_hours_details_object_request_body.rb +66 -0
  882. data/lib/samsara_api/types/scheduled_maintenance_by_engine_hours_details_object_response_body.rb +66 -0
  883. data/lib/samsara_api/types/scheduled_maintenance_by_engine_hours_response_body.rb +93 -0
  884. data/lib/samsara_api/types/scheduled_maintenance_data_response_body.rb +91 -0
  885. data/lib/samsara_api/types/scheduled_maintenance_odometer_data_response_body.rb +93 -0
  886. data/lib/samsara_api/types/scheduled_maintenance_odometer_trigger_details_object_request_body.rb +66 -0
  887. data/lib/samsara_api/types/scheduled_maintenance_odometer_trigger_details_object_response_body.rb +66 -0
  888. data/lib/samsara_api/types/scheduled_maintenance_trigger_details_object_request_body.rb +66 -0
  889. data/lib/samsara_api/types/scheduled_maintenance_trigger_details_object_response_body.rb +66 -0
  890. data/lib/samsara_api/types/scope_object_request_body.rb +103 -0
  891. data/lib/samsara_api/types/scope_object_response_body.rb +103 -0
  892. data/lib/samsara_api/types/sensor.rb +70 -0
  893. data/lib/samsara_api/types/sensor_response_body.rb +71 -0
  894. data/lib/samsara_api/types/service_task_definition_object_response_body.rb +109 -0
  895. data/lib/samsara_api/types/service_task_instance_input_object_request_body.rb +112 -0
  896. data/lib/samsara_api/types/service_task_instance_input_object_request_body_status.rb +17 -0
  897. data/lib/samsara_api/types/service_task_instance_object_response_body.rb +109 -0
  898. data/lib/samsara_api/types/service_task_instance_object_response_body_status.rb +17 -0
  899. data/lib/samsara_api/types/service_unavailable_error_response_body.rb +64 -0
  900. data/lib/samsara_api/types/settings_compliance_response_object_response_body.rb +127 -0
  901. data/lib/samsara_api/types/settings_get_compliance_settings_response_body.rb +61 -0
  902. data/lib/samsara_api/types/settings_get_driver_app_settings_response_body.rb +61 -0
  903. data/lib/samsara_api/types/settings_patch_compliance_settings_response_body.rb +61 -0
  904. data/lib/samsara_api/types/settings_patch_driver_app_settings_response_body.rb +61 -0
  905. data/lib/samsara_api/types/settings_response_body.rb +62 -0
  906. data/lib/samsara_api/types/severe_speeding_started_object_response_body.rb +85 -0
  907. data/lib/samsara_api/types/severe_speeding_started_response_object_response_body.rb +62 -0
  908. data/lib/samsara_api/types/signatory_user_object_response_body.rb +54 -0
  909. data/lib/samsara_api/types/signature_field_type_meta_data_object_response_body.rb +58 -0
  910. data/lib/samsara_api/types/signature_value_object_request_body.rb +85 -0
  911. data/lib/samsara_api/types/signature_value_object_response_body.rb +85 -0
  912. data/lib/samsara_api/types/single_approval_requirements_object_response_body.rb +56 -0
  913. data/lib/samsara_api/types/site_gateway_disconnected_response_body.rb +91 -0
  914. data/lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb +69 -0
  915. data/lib/samsara_api/types/specific_vehicle_fault_code_object_request_body_type.rb +16 -0
  916. data/lib/samsara_api/types/specific_vehicle_fault_code_object_response_body.rb +69 -0
  917. data/lib/samsara_api/types/specific_vehicle_fault_code_object_response_body_type.rb +16 -0
  918. data/lib/samsara_api/types/speed_data_response_body.rb +122 -0
  919. data/lib/samsara_api/types/speed_data_response_body_operation.rb +16 -0
  920. data/lib/samsara_api/types/speed_response_response_body.rb +66 -0
  921. data/lib/samsara_api/types/speed_trigger_details_object_request_body.rb +72 -0
  922. data/lib/samsara_api/types/speed_trigger_details_object_request_body_operation.rb +13 -0
  923. data/lib/samsara_api/types/speed_trigger_details_object_response_body.rb +73 -0
  924. data/lib/samsara_api/types/speed_trigger_details_object_response_body_operation.rb +13 -0
  925. data/lib/samsara_api/types/speeding_interval_location_response_response_body.rb +97 -0
  926. data/lib/samsara_api/types/speeding_interval_response_body.rb +108 -0
  927. data/lib/samsara_api/types/speeding_interval_response_body_severity_level.rb +16 -0
  928. data/lib/samsara_api/types/speeding_intervals_get_speeding_intervals_response_body.rb +75 -0
  929. data/lib/samsara_api/types/speeding_settings_object_response_body.rb +73 -0
  930. data/lib/samsara_api/types/speeding_settings_object_response_body_unit.rb +15 -0
  931. data/lib/samsara_api/types/speeding_severity_level_response_body.rb +83 -0
  932. data/lib/samsara_api/types/speeding_severity_level_response_body_severity_level.rb +15 -0
  933. data/lib/samsara_api/types/stream_work_orders_response_body.rb +73 -0
  934. data/lib/samsara_api/types/sudden_fuel_level_drop_response_body.rb +129 -0
  935. data/lib/samsara_api/types/sudden_fuel_level_drop_trigger_details_object_request_body.rb +58 -0
  936. data/lib/samsara_api/types/sudden_fuel_level_drop_trigger_details_object_response_body.rb +58 -0
  937. data/lib/samsara_api/types/sudden_fuel_level_rise_response_body.rb +129 -0
  938. data/lib/samsara_api/types/sudden_fuel_level_rise_trigger_details_object_request_body.rb +58 -0
  939. data/lib/samsara_api/types/sudden_fuel_level_rise_trigger_details_object_response_body.rb +58 -0
  940. data/lib/samsara_api/types/tachograph_activity.rb +85 -0
  941. data/lib/samsara_api/types/tachograph_activity_list.rb +8 -0
  942. data/lib/samsara_api/types/tachograph_activity_list_wrapper.rb +75 -0
  943. data/lib/samsara_api/types/tachograph_activity_state.rb +17 -0
  944. data/lib/samsara_api/types/tachograph_driver_file.rb +86 -0
  945. data/lib/samsara_api/types/tachograph_driver_file_data.rb +8 -0
  946. data/lib/samsara_api/types/tachograph_driver_file_list.rb +8 -0
  947. data/lib/samsara_api/types/tachograph_driver_file_list_wrapper.rb +75 -0
  948. data/lib/samsara_api/types/tachograph_driver_files_response.rb +76 -0
  949. data/lib/samsara_api/types/tachograph_vehicle_file.rb +86 -0
  950. data/lib/samsara_api/types/tachograph_vehicle_file_data.rb +8 -0
  951. data/lib/samsara_api/types/tachograph_vehicle_file_list.rb +8 -0
  952. data/lib/samsara_api/types/tachograph_vehicle_file_list_wrapper.rb +75 -0
  953. data/lib/samsara_api/types/tachograph_vehicle_files_response.rb +76 -0
  954. data/lib/samsara_api/types/tag.rb +161 -0
  955. data/lib/samsara_api/types/tag_all_of.rb +140 -0
  956. data/lib/samsara_api/types/tag_all_of_external_ids.rb +48 -0
  957. data/lib/samsara_api/types/tag_response.rb +62 -0
  958. data/lib/samsara_api/types/tag_tiny_response.rb +75 -0
  959. data/lib/samsara_api/types/tagged_object.rb +65 -0
  960. data/lib/samsara_api/types/tampering_detected_response_body.rb +91 -0
  961. data/lib/samsara_api/types/time_range_object_request_body.rb +89 -0
  962. data/lib/samsara_api/types/time_range_object_request_body_days_of_week_item.rb +19 -0
  963. data/lib/samsara_api/types/time_range_object_response_body.rb +89 -0
  964. data/lib/samsara_api/types/time_range_object_response_body_days_of_week_item.rb +19 -0
  965. data/lib/samsara_api/types/timeout_error_response_body.rb +64 -0
  966. data/lib/samsara_api/types/tiny_asset_object_request_body.rb +73 -0
  967. data/lib/samsara_api/types/tiny_asset_object_request_body_asset_type.rb +20 -0
  968. data/lib/samsara_api/types/tiny_asset_object_response_body.rb +73 -0
  969. data/lib/samsara_api/types/tiny_asset_object_response_body_asset_type.rb +20 -0
  970. data/lib/samsara_api/types/tiny_driver_object_request_body.rb +54 -0
  971. data/lib/samsara_api/types/tiny_driver_object_response_body.rb +54 -0
  972. data/lib/samsara_api/types/tiny_tag.rb +72 -0
  973. data/lib/samsara_api/types/tiny_widget_object_request_body.rb +54 -0
  974. data/lib/samsara_api/types/tiny_widget_object_response_body.rb +54 -0
  975. data/lib/samsara_api/types/tire_fault_code_details_object_request_body.rb +94 -0
  976. data/lib/samsara_api/types/tire_fault_code_details_object_request_body_manufacturer.rb +22 -0
  977. data/lib/samsara_api/types/tire_fault_code_details_object_request_body_specific_tire_fault_codes_item.rb +28 -0
  978. data/lib/samsara_api/types/tire_fault_code_details_object_response_body.rb +94 -0
  979. data/lib/samsara_api/types/tire_fault_code_details_object_response_body_manufacturer.rb +22 -0
  980. data/lib/samsara_api/types/tire_fault_code_details_object_response_body_specific_tire_fault_codes_item.rb +28 -0
  981. data/lib/samsara_api/types/tire_faults_response_body.rb +91 -0
  982. data/lib/samsara_api/types/too_many_requests_error_response_body.rb +64 -0
  983. data/lib/samsara_api/types/trailer_assignments_create_driver_trailer_assignment_response_body.rb +61 -0
  984. data/lib/samsara_api/types/trailer_assignments_get_driver_trailer_assignments_response_body.rb +77 -0
  985. data/lib/samsara_api/types/trailer_assignments_update_driver_trailer_assignment_response_body.rb +61 -0
  986. data/lib/samsara_api/types/trailer_dvir_object_response_body.rb +66 -0
  987. data/lib/samsara_api/types/trailer_goa_gateway_tiny_response_response_body.rb +78 -0
  988. data/lib/samsara_api/types/trailer_goa_gateway_tiny_response_response_body_model.rb +59 -0
  989. data/lib/samsara_api/types/trailer_object_response_body.rb +54 -0
  990. data/lib/samsara_api/types/trailer_response_object_response_body.rb +142 -0
  991. data/lib/samsara_api/types/trailer_tiny_response.rb +66 -0
  992. data/lib/samsara_api/types/trailer_with_attributes_response_object_response_body.rb +155 -0
  993. data/lib/samsara_api/types/trailers_create_trailer_bad_gateway_error_response_body.rb +66 -0
  994. data/lib/samsara_api/types/trailers_create_trailer_gateway_timeout_error_response_body.rb +66 -0
  995. data/lib/samsara_api/types/trailers_create_trailer_internal_server_error_response_body.rb +66 -0
  996. data/lib/samsara_api/types/trailers_create_trailer_method_not_allowed_error_response_body.rb +66 -0
  997. data/lib/samsara_api/types/trailers_create_trailer_not_found_error_response_body.rb +66 -0
  998. data/lib/samsara_api/types/trailers_create_trailer_not_implemented_error_response_body.rb +66 -0
  999. data/lib/samsara_api/types/trailers_create_trailer_response_body.rb +59 -0
  1000. data/lib/samsara_api/types/trailers_create_trailer_service_unavailable_error_response_body.rb +66 -0
  1001. data/lib/samsara_api/types/trailers_create_trailer_too_many_requests_error_response_body.rb +66 -0
  1002. data/lib/samsara_api/types/trailers_create_trailer_unauthorized_error_response_body.rb +66 -0
  1003. data/lib/samsara_api/types/trailers_delete_trailer_bad_gateway_error_response_body.rb +66 -0
  1004. data/lib/samsara_api/types/trailers_delete_trailer_gateway_timeout_error_response_body.rb +66 -0
  1005. data/lib/samsara_api/types/trailers_delete_trailer_internal_server_error_response_body.rb +66 -0
  1006. data/lib/samsara_api/types/trailers_delete_trailer_method_not_allowed_error_response_body.rb +66 -0
  1007. data/lib/samsara_api/types/trailers_delete_trailer_not_found_error_response_body.rb +66 -0
  1008. data/lib/samsara_api/types/trailers_delete_trailer_not_implemented_error_response_body.rb +66 -0
  1009. data/lib/samsara_api/types/trailers_delete_trailer_service_unavailable_error_response_body.rb +66 -0
  1010. data/lib/samsara_api/types/trailers_delete_trailer_too_many_requests_error_response_body.rb +66 -0
  1011. data/lib/samsara_api/types/trailers_delete_trailer_unauthorized_error_response_body.rb +66 -0
  1012. data/lib/samsara_api/types/trailers_get_trailer_bad_gateway_error_response_body.rb +66 -0
  1013. data/lib/samsara_api/types/trailers_get_trailer_gateway_timeout_error_response_body.rb +66 -0
  1014. data/lib/samsara_api/types/trailers_get_trailer_internal_server_error_response_body.rb +66 -0
  1015. data/lib/samsara_api/types/trailers_get_trailer_method_not_allowed_error_response_body.rb +66 -0
  1016. data/lib/samsara_api/types/trailers_get_trailer_not_found_error_response_body.rb +66 -0
  1017. data/lib/samsara_api/types/trailers_get_trailer_not_implemented_error_response_body.rb +66 -0
  1018. data/lib/samsara_api/types/trailers_get_trailer_response_body.rb +59 -0
  1019. data/lib/samsara_api/types/trailers_get_trailer_service_unavailable_error_response_body.rb +66 -0
  1020. data/lib/samsara_api/types/trailers_get_trailer_too_many_requests_error_response_body.rb +66 -0
  1021. data/lib/samsara_api/types/trailers_get_trailer_unauthorized_error_response_body.rb +66 -0
  1022. data/lib/samsara_api/types/trailers_list_trailers_bad_gateway_error_response_body.rb +66 -0
  1023. data/lib/samsara_api/types/trailers_list_trailers_gateway_timeout_error_response_body.rb +66 -0
  1024. data/lib/samsara_api/types/trailers_list_trailers_internal_server_error_response_body.rb +66 -0
  1025. data/lib/samsara_api/types/trailers_list_trailers_method_not_allowed_error_response_body.rb +66 -0
  1026. data/lib/samsara_api/types/trailers_list_trailers_not_found_error_response_body.rb +66 -0
  1027. data/lib/samsara_api/types/trailers_list_trailers_not_implemented_error_response_body.rb +66 -0
  1028. data/lib/samsara_api/types/trailers_list_trailers_response_body.rb +73 -0
  1029. data/lib/samsara_api/types/trailers_list_trailers_service_unavailable_error_response_body.rb +66 -0
  1030. data/lib/samsara_api/types/trailers_list_trailers_too_many_requests_error_response_body.rb +66 -0
  1031. data/lib/samsara_api/types/trailers_list_trailers_unauthorized_error_response_body.rb +66 -0
  1032. data/lib/samsara_api/types/trailers_update_trailer_bad_gateway_error_response_body.rb +66 -0
  1033. data/lib/samsara_api/types/trailers_update_trailer_gateway_timeout_error_response_body.rb +66 -0
  1034. data/lib/samsara_api/types/trailers_update_trailer_internal_server_error_response_body.rb +66 -0
  1035. data/lib/samsara_api/types/trailers_update_trailer_method_not_allowed_error_response_body.rb +66 -0
  1036. data/lib/samsara_api/types/trailers_update_trailer_not_found_error_response_body.rb +66 -0
  1037. data/lib/samsara_api/types/trailers_update_trailer_not_implemented_error_response_body.rb +66 -0
  1038. data/lib/samsara_api/types/trailers_update_trailer_response_body.rb +59 -0
  1039. data/lib/samsara_api/types/trailers_update_trailer_service_unavailable_error_response_body.rb +66 -0
  1040. data/lib/samsara_api/types/trailers_update_trailer_too_many_requests_error_response_body.rb +66 -0
  1041. data/lib/samsara_api/types/trailers_update_trailer_unauthorized_error_response_body.rb +66 -0
  1042. data/lib/samsara_api/types/training_assignment_response_object_response_body.rb +231 -0
  1043. data/lib/samsara_api/types/training_assignment_response_object_response_body_status.rb +15 -0
  1044. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_bad_gateway_error_response_body.rb +67 -0
  1045. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_gateway_timeout_error_response_body.rb +67 -0
  1046. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_internal_server_error_response_body.rb +67 -0
  1047. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_method_not_allowed_error_response_body.rb +67 -0
  1048. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_not_found_error_response_body.rb +67 -0
  1049. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_not_implemented_error_response_body.rb +67 -0
  1050. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_response_body.rb +75 -0
  1051. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_service_unavailable_error_response_body.rb +67 -0
  1052. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_too_many_requests_error_response_body.rb +67 -0
  1053. data/lib/samsara_api/types/training_assignments_get_training_assignments_stream_unauthorized_error_response_body.rb +67 -0
  1054. data/lib/samsara_api/types/training_category_object_response_body.rb +64 -0
  1055. data/lib/samsara_api/types/training_course_label_object_response_body.rb +77 -0
  1056. data/lib/samsara_api/types/training_course_object_response_body.rb +64 -0
  1057. data/lib/samsara_api/types/training_course_response_object_response_body.rb +129 -0
  1058. data/lib/samsara_api/types/training_course_response_object_response_body_status.rb +19 -0
  1059. data/lib/samsara_api/types/training_learner_object_response_body.rb +65 -0
  1060. data/lib/samsara_api/types/trigger_params_object_request_body.rb +489 -0
  1061. data/lib/samsara_api/types/trigger_params_object_response_body.rb +489 -0
  1062. data/lib/samsara_api/types/trip_asset_response_body.rb +89 -0
  1063. data/lib/samsara_api/types/trip_asset_response_body_type.rb +18 -0
  1064. data/lib/samsara_api/types/trip_response_body.rb +128 -0
  1065. data/lib/samsara_api/types/trip_response_body_completion_status.rb +13 -0
  1066. data/lib/samsara_api/types/trip_speeding_intervals_response_body.rb +110 -0
  1067. data/lib/samsara_api/types/trips_get_trips_bad_gateway_error_response_body.rb +66 -0
  1068. data/lib/samsara_api/types/trips_get_trips_gateway_timeout_error_response_body.rb +66 -0
  1069. data/lib/samsara_api/types/trips_get_trips_internal_server_error_response_body.rb +66 -0
  1070. data/lib/samsara_api/types/trips_get_trips_method_not_allowed_error_response_body.rb +66 -0
  1071. data/lib/samsara_api/types/trips_get_trips_not_found_error_response_body.rb +65 -0
  1072. data/lib/samsara_api/types/trips_get_trips_not_implemented_error_response_body.rb +66 -0
  1073. data/lib/samsara_api/types/trips_get_trips_response_body.rb +73 -0
  1074. data/lib/samsara_api/types/trips_get_trips_service_unavailable_error_response_body.rb +66 -0
  1075. data/lib/samsara_api/types/trips_get_trips_too_many_requests_error_response_body.rb +66 -0
  1076. data/lib/samsara_api/types/trips_get_trips_unauthorized_error_response_body.rb +66 -0
  1077. data/lib/samsara_api/types/unassigned_driving_data_response_body.rb +78 -0
  1078. data/lib/samsara_api/types/unassigned_driving_trigger_details_object_request_body.rb +56 -0
  1079. data/lib/samsara_api/types/unassigned_driving_trigger_details_object_response_body.rb +56 -0
  1080. data/lib/samsara_api/types/unauthorized_error_response_body.rb +64 -0
  1081. data/lib/samsara_api/types/unavailable_error_response_body.rb +64 -0
  1082. data/lib/samsara_api/types/unit_response_body.rb +92 -0
  1083. data/lib/samsara_api/types/unit_response_body_base_unit.rb +73 -0
  1084. data/lib/samsara_api/types/unit_response_body_measurement_type.rb +33 -0
  1085. data/lib/samsara_api/types/update_address_request_geofence.rb +92 -0
  1086. data/lib/samsara_api/types/update_driver_request_hos_setting.rb +56 -0
  1087. data/lib/samsara_api/types/update_routes_stop_request_object_request_body.rb +151 -0
  1088. data/lib/samsara_api/types/uploaded_media_object_response_body.rb +134 -0
  1089. data/lib/samsara_api/types/uploaded_media_object_response_body_input.rb +15 -0
  1090. data/lib/samsara_api/types/uploaded_media_object_response_body_media_type.rb +13 -0
  1091. data/lib/samsara_api/types/uploaded_media_object_response_body_trigger_reason.rb +21 -0
  1092. data/lib/samsara_api/types/url_info_object_response_body.rb +69 -0
  1093. data/lib/samsara_api/types/us_driver_ruleset_override.rb +117 -0
  1094. data/lib/samsara_api/types/us_driver_ruleset_override_cycle.rb +49 -0
  1095. data/lib/samsara_api/types/us_driver_ruleset_override_restart.rb +18 -0
  1096. data/lib/samsara_api/types/us_driver_ruleset_override_restbreak.rb +15 -0
  1097. data/lib/samsara_api/types/us_driver_ruleset_override_us_state_to_override.rb +25 -0
  1098. data/lib/samsara_api/types/user.rb +90 -0
  1099. data/lib/samsara_api/types/user_auth_type.rb +15 -0
  1100. data/lib/samsara_api/types/user_response.rb +62 -0
  1101. data/lib/samsara_api/types/user_role.rb +66 -0
  1102. data/lib/samsara_api/types/user_role_assignment.rb +90 -0
  1103. data/lib/samsara_api/types/user_roles.rb +8 -0
  1104. data/lib/samsara_api/types/user_tiny_response.rb +66 -0
  1105. data/lib/samsara_api/types/v_1_message.rb +63 -0
  1106. data/lib/samsara_api/types/v_1_message_response.rb +90 -0
  1107. data/lib/samsara_api/types/v_1_message_sender.rb +63 -0
  1108. data/lib/samsara_api/types/v_1_messages.rb +8 -0
  1109. data/lib/samsara_api/types/v_1_messages_response.rb +8 -0
  1110. data/lib/samsara_api/types/vehicle.rb +325 -0
  1111. data/lib/samsara_api/types/vehicle_assignment_object_response_body.rb +108 -0
  1112. data/lib/samsara_api/types/vehicle_batter_voltage_details_object_request_body.rb +74 -0
  1113. data/lib/samsara_api/types/vehicle_batter_voltage_details_object_request_body_operation.rb +13 -0
  1114. data/lib/samsara_api/types/vehicle_batter_voltage_details_object_response_body.rb +74 -0
  1115. data/lib/samsara_api/types/vehicle_batter_voltage_details_object_response_body_operation.rb +13 -0
  1116. data/lib/samsara_api/types/vehicle_battery_voltage_response_body.rb +91 -0
  1117. data/lib/samsara_api/types/vehicle_def_level_percentage_response_body.rb +92 -0
  1118. data/lib/samsara_api/types/vehicle_detected_response_body.rb +62 -0
  1119. data/lib/samsara_api/types/vehicle_dvir_object_response_body.rb +66 -0
  1120. data/lib/samsara_api/types/vehicle_external_ids.rb +7 -0
  1121. data/lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb +110 -0
  1122. data/lib/samsara_api/types/vehicle_fault_code_details_object_response_body.rb +110 -0
  1123. data/lib/samsara_api/types/vehicle_faults_response_body.rb +91 -0
  1124. data/lib/samsara_api/types/vehicle_harsh_acceleration_setting_type.rb +23 -0
  1125. data/lib/samsara_api/types/vehicle_location.rb +100 -0
  1126. data/lib/samsara_api/types/vehicle_location_address.rb +66 -0
  1127. data/lib/samsara_api/types/vehicle_locations_list_response.rb +74 -0
  1128. data/lib/samsara_api/types/vehicle_locations_list_response_data.rb +75 -0
  1129. data/lib/samsara_api/types/vehicle_locations_response.rb +74 -0
  1130. data/lib/samsara_api/types/vehicle_locations_response_data.rb +77 -0
  1131. data/lib/samsara_api/types/vehicle_regulation_mode.rb +15 -0
  1132. data/lib/samsara_api/types/vehicle_response.rb +60 -0
  1133. data/lib/samsara_api/types/vehicle_response_object_response_body.rb +368 -0
  1134. data/lib/samsara_api/types/vehicle_response_object_response_body_vehicle_regulation_mode.rb +14 -0
  1135. data/lib/samsara_api/types/vehicle_response_object_response_body_vehicle_type.rb +16 -0
  1136. data/lib/samsara_api/types/vehicle_response_response_body.rb +97 -0
  1137. data/lib/samsara_api/types/vehicle_response_response_body_asset_type.rb +17 -0
  1138. data/lib/samsara_api/types/vehicle_sensor_configuration.rb +74 -0
  1139. data/lib/samsara_api/types/vehicle_sensor_configuration_area.rb +91 -0
  1140. data/lib/samsara_api/types/vehicle_sensor_configuration_area_position.rb +14 -0
  1141. data/lib/samsara_api/types/vehicle_sensor_configuration_area_response_body.rb +93 -0
  1142. data/lib/samsara_api/types/vehicle_sensor_configuration_area_response_body_position.rb +14 -0
  1143. data/lib/samsara_api/types/vehicle_sensor_configuration_door.rb +73 -0
  1144. data/lib/samsara_api/types/vehicle_sensor_configuration_door_position.rb +13 -0
  1145. data/lib/samsara_api/types/vehicle_sensor_configuration_door_response_body.rb +75 -0
  1146. data/lib/samsara_api/types/vehicle_sensor_configuration_door_response_body_position.rb +15 -0
  1147. data/lib/samsara_api/types/vehicle_sensor_configuration_response_body.rb +75 -0
  1148. data/lib/samsara_api/types/vehicle_stats_ambient_air_temp_milli_c.rb +64 -0
  1149. data/lib/samsara_api/types/vehicle_stats_ambient_air_temp_milli_c_with_decoration.rb +81 -0
  1150. data/lib/samsara_api/types/vehicle_stats_aux_input.rb +73 -0
  1151. data/lib/samsara_api/types/vehicle_stats_aux_input_decoration.rb +77 -0
  1152. data/lib/samsara_api/types/vehicle_stats_aux_input_with_decoration.rb +86 -0
  1153. data/lib/samsara_api/types/vehicle_stats_barometric_pressure_pa.rb +64 -0
  1154. data/lib/samsara_api/types/vehicle_stats_barometric_pressure_pa_with_decoration.rb +81 -0
  1155. data/lib/samsara_api/types/vehicle_stats_battery_voltage.rb +64 -0
  1156. data/lib/samsara_api/types/vehicle_stats_battery_voltage_with_decoration.rb +81 -0
  1157. data/lib/samsara_api/types/vehicle_stats_decorations.rb +806 -0
  1158. data/lib/samsara_api/types/vehicle_stats_decorations_ambient_air_temperature_milli_c.rb +55 -0
  1159. data/lib/samsara_api/types/vehicle_stats_decorations_barometric_pressure_pa.rb +55 -0
  1160. data/lib/samsara_api/types/vehicle_stats_decorations_battery_milli_volts.rb +55 -0
  1161. data/lib/samsara_api/types/vehicle_stats_decorations_def_level_milli_percent.rb +55 -0
  1162. data/lib/samsara_api/types/vehicle_stats_decorations_ecu_speed_mph.rb +53 -0
  1163. data/lib/samsara_api/types/vehicle_stats_decorations_engine_coolant_temperature_milli_c.rb +55 -0
  1164. data/lib/samsara_api/types/vehicle_stats_decorations_engine_load_percent.rb +55 -0
  1165. data/lib/samsara_api/types/vehicle_stats_decorations_engine_oil_pressure_k_pa.rb +55 -0
  1166. data/lib/samsara_api/types/vehicle_stats_decorations_engine_rpm.rb +53 -0
  1167. data/lib/samsara_api/types/vehicle_stats_decorations_engine_states.rb +54 -0
  1168. data/lib/samsara_api/types/vehicle_stats_decorations_engine_states_value.rb +14 -0
  1169. data/lib/samsara_api/types/vehicle_stats_decorations_fuel_percents.rb +53 -0
  1170. data/lib/samsara_api/types/vehicle_stats_decorations_gps.rb +112 -0
  1171. data/lib/samsara_api/types/vehicle_stats_decorations_gps_distance_meters.rb +55 -0
  1172. data/lib/samsara_api/types/vehicle_stats_decorations_gps_odometer_meters.rb +55 -0
  1173. data/lib/samsara_api/types/vehicle_stats_decorations_intake_manifold_temperature_milli_c.rb +55 -0
  1174. data/lib/samsara_api/types/vehicle_stats_decorations_obd_engine_seconds.rb +55 -0
  1175. data/lib/samsara_api/types/vehicle_stats_decorations_obd_odometer_meters.rb +55 -0
  1176. data/lib/samsara_api/types/vehicle_stats_def_level_milli_percent.rb +66 -0
  1177. data/lib/samsara_api/types/vehicle_stats_def_level_milli_percent_with_decoration.rb +83 -0
  1178. data/lib/samsara_api/types/vehicle_stats_ecu_speed_mph.rb +64 -0
  1179. data/lib/samsara_api/types/vehicle_stats_ecu_speed_mph_with_decoration.rb +80 -0
  1180. data/lib/samsara_api/types/vehicle_stats_engine_coolant_temp_milli_c.rb +64 -0
  1181. data/lib/samsara_api/types/vehicle_stats_engine_coolant_temp_milli_c_with_decoration.rb +81 -0
  1182. data/lib/samsara_api/types/vehicle_stats_engine_immobilizer.rb +82 -0
  1183. data/lib/samsara_api/types/vehicle_stats_engine_immobilizer_state.rb +18 -0
  1184. data/lib/samsara_api/types/vehicle_stats_engine_immobilizer_with_decoration.rb +99 -0
  1185. data/lib/samsara_api/types/vehicle_stats_engine_immobilizer_with_decoration_state.rb +18 -0
  1186. data/lib/samsara_api/types/vehicle_stats_engine_load_percent.rb +64 -0
  1187. data/lib/samsara_api/types/vehicle_stats_engine_load_percent_with_decoration.rb +81 -0
  1188. data/lib/samsara_api/types/vehicle_stats_engine_oil_pressure_k_pa.rb +64 -0
  1189. data/lib/samsara_api/types/vehicle_stats_engine_oil_pressure_k_pa_with_decoration.rb +81 -0
  1190. data/lib/samsara_api/types/vehicle_stats_engine_rpm.rb +64 -0
  1191. data/lib/samsara_api/types/vehicle_stats_engine_rpm_with_decoration.rb +79 -0
  1192. data/lib/samsara_api/types/vehicle_stats_engine_state.rb +65 -0
  1193. data/lib/samsara_api/types/vehicle_stats_engine_state_setting.rb +14 -0
  1194. data/lib/samsara_api/types/vehicle_stats_engine_state_with_decoration.rb +81 -0
  1195. data/lib/samsara_api/types/vehicle_stats_ev_average_battery_temperature_milli_celsius.rb +67 -0
  1196. data/lib/samsara_api/types/vehicle_stats_ev_battery_current_milli_amp.rb +65 -0
  1197. data/lib/samsara_api/types/vehicle_stats_ev_battery_state_of_health_milli_percent.rb +67 -0
  1198. data/lib/samsara_api/types/vehicle_stats_ev_battery_voltage_milli_volt.rb +66 -0
  1199. data/lib/samsara_api/types/vehicle_stats_ev_charging_current_milli_amp.rb +66 -0
  1200. data/lib/samsara_api/types/vehicle_stats_ev_charging_energy_micro_wh.rb +65 -0
  1201. data/lib/samsara_api/types/vehicle_stats_ev_charging_status.rb +71 -0
  1202. data/lib/samsara_api/types/vehicle_stats_ev_charging_voltage_milli_volt.rb +66 -0
  1203. data/lib/samsara_api/types/vehicle_stats_ev_consumed_energy_micro_wh.rb +67 -0
  1204. data/lib/samsara_api/types/vehicle_stats_ev_distance_driven_meters.rb +65 -0
  1205. data/lib/samsara_api/types/vehicle_stats_ev_regenerated_energy_micro_wh.rb +66 -0
  1206. data/lib/samsara_api/types/vehicle_stats_ev_state_of_charge_milli_percent.rb +67 -0
  1207. data/lib/samsara_api/types/vehicle_stats_fault_codes.rb +105 -0
  1208. data/lib/samsara_api/types/vehicle_stats_fault_codes_ignition_type.rb +14 -0
  1209. data/lib/samsara_api/types/vehicle_stats_fault_codes_j_1939.rb +76 -0
  1210. data/lib/samsara_api/types/vehicle_stats_fault_codes_j_1939_lights.rb +78 -0
  1211. data/lib/samsara_api/types/vehicle_stats_fault_codes_j_1939_trouble_code.rb +122 -0
  1212. data/lib/samsara_api/types/vehicle_stats_fault_codes_j_1939_trouble_codes.rb +8 -0
  1213. data/lib/samsara_api/types/vehicle_stats_fault_codes_obdii.rb +72 -0
  1214. data/lib/samsara_api/types/vehicle_stats_fault_codes_obdii_trouble_code.rb +119 -0
  1215. data/lib/samsara_api/types/vehicle_stats_fault_codes_oem.rb +60 -0
  1216. data/lib/samsara_api/types/vehicle_stats_fault_codes_oem_trouble_code.rb +80 -0
  1217. data/lib/samsara_api/types/vehicle_stats_fault_codes_oem_trouble_codes.rb +8 -0
  1218. data/lib/samsara_api/types/vehicle_stats_fault_codes_passenger_dtc.rb +73 -0
  1219. data/lib/samsara_api/types/vehicle_stats_fault_codes_passenger_monitor_status.rb +139 -0
  1220. data/lib/samsara_api/types/vehicle_stats_fault_codes_passenger_monitor_status_value.rb +17 -0
  1221. data/lib/samsara_api/types/vehicle_stats_fault_codes_value.rb +98 -0
  1222. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_j_1939.rb +76 -0
  1223. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_j_1939_check_engine_lights.rb +80 -0
  1224. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_j_1939_diagnostic_trouble_codes.rb +123 -0
  1225. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_j_1939_vendor_specific_fields.rb +68 -0
  1226. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii.rb +72 -0
  1227. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_confirmed_dtcs.rb +75 -0
  1228. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_diagnostic_trouble_codes.rb +122 -0
  1229. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_diagnostic_trouble_codes_ignition_type.rb +14 -0
  1230. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status.rb +215 -0
  1231. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_catalyst.rb +17 -0
  1232. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_comprehensive.rb +17 -0
  1233. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_egr.rb +17 -0
  1234. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_evap_system.rb +17 -0
  1235. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_fuel.rb +17 -0
  1236. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_heated_catalyst.rb +17 -0
  1237. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_heated_o_2_sensor.rb +17 -0
  1238. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_iso_sae_reserved.rb +17 -0
  1239. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_misfire.rb +17 -0
  1240. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_o_2_sensor.rb +17 -0
  1241. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_monitor_status_secondary_air.rb +17 -0
  1242. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_oem.rb +60 -0
  1243. data/lib/samsara_api/types/vehicle_stats_fault_codes_value_oem_diagnostic_trouble_codes.rb +82 -0
  1244. data/lib/samsara_api/types/vehicle_stats_fault_codes_vendor_specific_fields.rb +68 -0
  1245. data/lib/samsara_api/types/vehicle_stats_fault_codes_with_decoration.rb +118 -0
  1246. data/lib/samsara_api/types/vehicle_stats_fuel_percent.rb +64 -0
  1247. data/lib/samsara_api/types/vehicle_stats_fuel_percent_with_decoration.rb +80 -0
  1248. data/lib/samsara_api/types/vehicle_stats_gps.rb +120 -0
  1249. data/lib/samsara_api/types/vehicle_stats_gps_distance_meters.rb +66 -0
  1250. data/lib/samsara_api/types/vehicle_stats_gps_distance_meters_with_decoration.rb +83 -0
  1251. data/lib/samsara_api/types/vehicle_stats_gps_odometer_meters.rb +66 -0
  1252. data/lib/samsara_api/types/vehicle_stats_gps_odometer_meters_with_decoration.rb +83 -0
  1253. data/lib/samsara_api/types/vehicle_stats_intake_manifold_temp_milli_c.rb +64 -0
  1254. data/lib/samsara_api/types/vehicle_stats_intake_manifold_temp_milli_c_with_decoration.rb +81 -0
  1255. data/lib/samsara_api/types/vehicle_stats_list_gps.rb +133 -0
  1256. data/lib/samsara_api/types/vehicle_stats_list_response.rb +74 -0
  1257. data/lib/samsara_api/types/vehicle_stats_list_response_data.rb +761 -0
  1258. data/lib/samsara_api/types/vehicle_stats_list_synthetic_engine_seconds.rb +80 -0
  1259. data/lib/samsara_api/types/vehicle_stats_nfc_card_scan.rb +70 -0
  1260. data/lib/samsara_api/types/vehicle_stats_nfc_card_scan_card.rb +56 -0
  1261. data/lib/samsara_api/types/vehicle_stats_nfc_card_scan_with_decoration.rb +86 -0
  1262. data/lib/samsara_api/types/vehicle_stats_obd_engine_seconds.rb +66 -0
  1263. data/lib/samsara_api/types/vehicle_stats_obd_engine_seconds_with_decoration.rb +83 -0
  1264. data/lib/samsara_api/types/vehicle_stats_obd_odometer_meters.rb +64 -0
  1265. data/lib/samsara_api/types/vehicle_stats_obd_odometer_meters_with_decoration.rb +81 -0
  1266. data/lib/samsara_api/types/vehicle_stats_response.rb +74 -0
  1267. data/lib/samsara_api/types/vehicle_stats_response_data.rb +829 -0
  1268. data/lib/samsara_api/types/vehicle_stats_response_ev_average_battery_temperature_milli_celsius.rb +67 -0
  1269. data/lib/samsara_api/types/vehicle_stats_response_ev_battery_current_milli_amp.rb +67 -0
  1270. data/lib/samsara_api/types/vehicle_stats_response_ev_battery_state_of_health_milli_percent.rb +67 -0
  1271. data/lib/samsara_api/types/vehicle_stats_response_ev_battery_voltage_milli_volt.rb +67 -0
  1272. data/lib/samsara_api/types/vehicle_stats_response_ev_charging_current_milli_amp.rb +67 -0
  1273. data/lib/samsara_api/types/vehicle_stats_response_ev_charging_energy_micro_wh.rb +67 -0
  1274. data/lib/samsara_api/types/vehicle_stats_response_ev_charging_status.rb +71 -0
  1275. data/lib/samsara_api/types/vehicle_stats_response_ev_charging_voltage_milli_volt.rb +67 -0
  1276. data/lib/samsara_api/types/vehicle_stats_response_ev_consumed_energy_micro_wh.rb +69 -0
  1277. data/lib/samsara_api/types/vehicle_stats_response_ev_distance_driven_meters.rb +67 -0
  1278. data/lib/samsara_api/types/vehicle_stats_response_ev_regenerated_energy_micro_wh.rb +67 -0
  1279. data/lib/samsara_api/types/vehicle_stats_response_ev_state_of_charge_milli_percent.rb +67 -0
  1280. data/lib/samsara_api/types/vehicle_stats_response_seatbelt_driver.rb +65 -0
  1281. data/lib/samsara_api/types/vehicle_stats_response_seatbelt_driver_value.rb +13 -0
  1282. data/lib/samsara_api/types/vehicle_stats_response_spreader_active.rb +65 -0
  1283. data/lib/samsara_api/types/vehicle_stats_response_spreader_active_value.rb +13 -0
  1284. data/lib/samsara_api/types/vehicle_stats_response_spreader_air_temp.rb +64 -0
  1285. data/lib/samsara_api/types/vehicle_stats_response_spreader_blast_state.rb +66 -0
  1286. data/lib/samsara_api/types/vehicle_stats_response_spreader_blast_state_value.rb +13 -0
  1287. data/lib/samsara_api/types/vehicle_stats_response_spreader_granular_name.rb +69 -0
  1288. data/lib/samsara_api/types/vehicle_stats_response_spreader_granular_rate.rb +78 -0
  1289. data/lib/samsara_api/types/vehicle_stats_response_spreader_liquid_name.rb +68 -0
  1290. data/lib/samsara_api/types/vehicle_stats_response_spreader_liquid_rate.rb +77 -0
  1291. data/lib/samsara_api/types/vehicle_stats_response_spreader_on_state.rb +65 -0
  1292. data/lib/samsara_api/types/vehicle_stats_response_spreader_on_state_value.rb +13 -0
  1293. data/lib/samsara_api/types/vehicle_stats_response_spreader_plow_status.rb +67 -0
  1294. data/lib/samsara_api/types/vehicle_stats_response_spreader_plow_status_value.rb +13 -0
  1295. data/lib/samsara_api/types/vehicle_stats_response_spreader_prewet_name.rb +68 -0
  1296. data/lib/samsara_api/types/vehicle_stats_response_spreader_prewet_rate.rb +77 -0
  1297. data/lib/samsara_api/types/vehicle_stats_response_spreader_road_temp.rb +64 -0
  1298. data/lib/samsara_api/types/vehicle_stats_seatbelt_driver.rb +65 -0
  1299. data/lib/samsara_api/types/vehicle_stats_seatbelt_driver_value.rb +13 -0
  1300. data/lib/samsara_api/types/vehicle_stats_spreader_active.rb +65 -0
  1301. data/lib/samsara_api/types/vehicle_stats_spreader_active_value.rb +13 -0
  1302. data/lib/samsara_api/types/vehicle_stats_spreader_air_temp.rb +64 -0
  1303. data/lib/samsara_api/types/vehicle_stats_spreader_blast_state.rb +65 -0
  1304. data/lib/samsara_api/types/vehicle_stats_spreader_blast_state_value.rb +13 -0
  1305. data/lib/samsara_api/types/vehicle_stats_spreader_granular_name.rb +67 -0
  1306. data/lib/samsara_api/types/vehicle_stats_spreader_granular_rate.rb +76 -0
  1307. data/lib/samsara_api/types/vehicle_stats_spreader_liquid_name.rb +67 -0
  1308. data/lib/samsara_api/types/vehicle_stats_spreader_liquid_rate.rb +76 -0
  1309. data/lib/samsara_api/types/vehicle_stats_spreader_on_state.rb +65 -0
  1310. data/lib/samsara_api/types/vehicle_stats_spreader_on_state_value.rb +13 -0
  1311. data/lib/samsara_api/types/vehicle_stats_spreader_plow_status.rb +66 -0
  1312. data/lib/samsara_api/types/vehicle_stats_spreader_plow_status_value.rb +13 -0
  1313. data/lib/samsara_api/types/vehicle_stats_spreader_prewet_name.rb +67 -0
  1314. data/lib/samsara_api/types/vehicle_stats_spreader_prewet_rate.rb +76 -0
  1315. data/lib/samsara_api/types/vehicle_stats_spreader_road_temp.rb +64 -0
  1316. data/lib/samsara_api/types/vehicle_stats_synthetic_engine_seconds.rb +79 -0
  1317. data/lib/samsara_api/types/vehicle_stats_tire_pressures.rb +88 -0
  1318. data/lib/samsara_api/types/vehicle_tags.rb +8 -0
  1319. data/lib/samsara_api/types/vehicle_tiny_response.rb +75 -0
  1320. data/lib/samsara_api/types/vehicle_with_gateway_tiny_response_response_body.rb +113 -0
  1321. data/lib/samsara_api/types/vehicle_with_gateway_tiny_response_response_body_asset_type.rb +17 -0
  1322. data/lib/samsara_api/types/vehicles_driver_assignments_object_response_body.rb +85 -0
  1323. data/lib/samsara_api/types/vehicles_list_vehicles_bad_gateway_error_response_body.rb +66 -0
  1324. data/lib/samsara_api/types/vehicles_list_vehicles_gateway_timeout_error_response_body.rb +66 -0
  1325. data/lib/samsara_api/types/vehicles_list_vehicles_internal_server_error_response_body.rb +66 -0
  1326. data/lib/samsara_api/types/vehicles_list_vehicles_method_not_allowed_error_response_body.rb +66 -0
  1327. data/lib/samsara_api/types/vehicles_list_vehicles_not_found_error_response_body.rb +66 -0
  1328. data/lib/samsara_api/types/vehicles_list_vehicles_not_implemented_error_response_body.rb +66 -0
  1329. data/lib/samsara_api/types/vehicles_list_vehicles_response_body.rb +73 -0
  1330. data/lib/samsara_api/types/vehicles_list_vehicles_service_unavailable_error_response_body.rb +66 -0
  1331. data/lib/samsara_api/types/vehicles_list_vehicles_too_many_requests_error_response_body.rb +66 -0
  1332. data/lib/samsara_api/types/vehicles_list_vehicles_unauthorized_error_response_body.rb +66 -0
  1333. data/lib/samsara_api/types/vertex_request_body.rb +66 -0
  1334. data/lib/samsara_api/types/vertex_response_body.rb +66 -0
  1335. data/lib/samsara_api/types/voice_coaching_settings_object_response_body.rb +89 -0
  1336. data/lib/samsara_api/types/voice_coaching_settings_object_response_body_events_to_coach_item.rb +18 -0
  1337. data/lib/samsara_api/types/voice_coaching_settings_object_response_body_language.rb +19 -0
  1338. data/lib/samsara_api/types/walkaround_photo_object_response_body.rb +73 -0
  1339. data/lib/samsara_api/types/webhook_event.rb +83 -0
  1340. data/lib/samsara_api/types/webhook_params_object_request_body.rb +71 -0
  1341. data/lib/samsara_api/types/webhook_params_object_request_body_payload_type.rb +15 -0
  1342. data/lib/samsara_api/types/webhook_params_object_response_body.rb +71 -0
  1343. data/lib/samsara_api/types/webhook_params_object_response_body_payload_type.rb +15 -0
  1344. data/lib/samsara_api/types/webhook_response_response_body.rb +119 -0
  1345. data/lib/samsara_api/types/webhook_response_response_body_event_types_item.rb +45 -0
  1346. data/lib/samsara_api/types/webhook_response_response_body_version.rb +13 -0
  1347. data/lib/samsara_api/types/webhook_route_response_object_response_body.rb +152 -0
  1348. data/lib/samsara_api/types/webhooks_delete_webhook_bad_gateway_error_response_body.rb +66 -0
  1349. data/lib/samsara_api/types/webhooks_delete_webhook_gateway_timeout_error_response_body.rb +66 -0
  1350. data/lib/samsara_api/types/webhooks_delete_webhook_internal_server_error_response_body.rb +66 -0
  1351. data/lib/samsara_api/types/webhooks_delete_webhook_method_not_allowed_error_response_body.rb +66 -0
  1352. data/lib/samsara_api/types/webhooks_delete_webhook_not_found_error_response_body.rb +66 -0
  1353. data/lib/samsara_api/types/webhooks_delete_webhook_not_implemented_error_response_body.rb +66 -0
  1354. data/lib/samsara_api/types/webhooks_delete_webhook_service_unavailable_error_response_body.rb +66 -0
  1355. data/lib/samsara_api/types/webhooks_delete_webhook_too_many_requests_error_response_body.rb +66 -0
  1356. data/lib/samsara_api/types/webhooks_delete_webhook_unauthorized_error_response_body.rb +66 -0
  1357. data/lib/samsara_api/types/webhooks_get_webhook_bad_gateway_error_response_body.rb +66 -0
  1358. data/lib/samsara_api/types/webhooks_get_webhook_gateway_timeout_error_response_body.rb +66 -0
  1359. data/lib/samsara_api/types/webhooks_get_webhook_internal_server_error_response_body.rb +66 -0
  1360. data/lib/samsara_api/types/webhooks_get_webhook_method_not_allowed_error_response_body.rb +66 -0
  1361. data/lib/samsara_api/types/webhooks_get_webhook_not_found_error_response_body.rb +66 -0
  1362. data/lib/samsara_api/types/webhooks_get_webhook_not_implemented_error_response_body.rb +66 -0
  1363. data/lib/samsara_api/types/webhooks_get_webhook_response_body.rb +118 -0
  1364. data/lib/samsara_api/types/webhooks_get_webhook_response_body_event_types_item.rb +45 -0
  1365. data/lib/samsara_api/types/webhooks_get_webhook_response_body_version.rb +13 -0
  1366. data/lib/samsara_api/types/webhooks_get_webhook_service_unavailable_error_response_body.rb +66 -0
  1367. data/lib/samsara_api/types/webhooks_get_webhook_too_many_requests_error_response_body.rb +66 -0
  1368. data/lib/samsara_api/types/webhooks_get_webhook_unauthorized_error_response_body.rb +66 -0
  1369. data/lib/samsara_api/types/webhooks_list_webhooks_bad_gateway_error_response_body.rb +66 -0
  1370. data/lib/samsara_api/types/webhooks_list_webhooks_gateway_timeout_error_response_body.rb +66 -0
  1371. data/lib/samsara_api/types/webhooks_list_webhooks_internal_server_error_response_body.rb +66 -0
  1372. data/lib/samsara_api/types/webhooks_list_webhooks_method_not_allowed_error_response_body.rb +66 -0
  1373. data/lib/samsara_api/types/webhooks_list_webhooks_not_found_error_response_body.rb +66 -0
  1374. data/lib/samsara_api/types/webhooks_list_webhooks_not_implemented_error_response_body.rb +66 -0
  1375. data/lib/samsara_api/types/webhooks_list_webhooks_response_body.rb +73 -0
  1376. data/lib/samsara_api/types/webhooks_list_webhooks_service_unavailable_error_response_body.rb +66 -0
  1377. data/lib/samsara_api/types/webhooks_list_webhooks_too_many_requests_error_response_body.rb +66 -0
  1378. data/lib/samsara_api/types/webhooks_list_webhooks_unauthorized_error_response_body.rb +66 -0
  1379. data/lib/samsara_api/types/webhooks_patch_webhook_bad_gateway_error_response_body.rb +66 -0
  1380. data/lib/samsara_api/types/webhooks_patch_webhook_gateway_timeout_error_response_body.rb +66 -0
  1381. data/lib/samsara_api/types/webhooks_patch_webhook_internal_server_error_response_body.rb +66 -0
  1382. data/lib/samsara_api/types/webhooks_patch_webhook_method_not_allowed_error_response_body.rb +66 -0
  1383. data/lib/samsara_api/types/webhooks_patch_webhook_not_found_error_response_body.rb +66 -0
  1384. data/lib/samsara_api/types/webhooks_patch_webhook_not_implemented_error_response_body.rb +66 -0
  1385. data/lib/samsara_api/types/webhooks_patch_webhook_response_body.rb +118 -0
  1386. data/lib/samsara_api/types/webhooks_patch_webhook_response_body_event_types_item.rb +45 -0
  1387. data/lib/samsara_api/types/webhooks_patch_webhook_response_body_version.rb +13 -0
  1388. data/lib/samsara_api/types/webhooks_patch_webhook_service_unavailable_error_response_body.rb +66 -0
  1389. data/lib/samsara_api/types/webhooks_patch_webhook_too_many_requests_error_response_body.rb +66 -0
  1390. data/lib/samsara_api/types/webhooks_patch_webhook_unauthorized_error_response_body.rb +66 -0
  1391. data/lib/samsara_api/types/webhooks_post_webhooks_bad_gateway_error_response_body.rb +66 -0
  1392. data/lib/samsara_api/types/webhooks_post_webhooks_gateway_timeout_error_response_body.rb +66 -0
  1393. data/lib/samsara_api/types/webhooks_post_webhooks_internal_server_error_response_body.rb +66 -0
  1394. data/lib/samsara_api/types/webhooks_post_webhooks_method_not_allowed_error_response_body.rb +66 -0
  1395. data/lib/samsara_api/types/webhooks_post_webhooks_not_found_error_response_body.rb +66 -0
  1396. data/lib/samsara_api/types/webhooks_post_webhooks_not_implemented_error_response_body.rb +66 -0
  1397. data/lib/samsara_api/types/webhooks_post_webhooks_response_body.rb +118 -0
  1398. data/lib/samsara_api/types/webhooks_post_webhooks_response_body_event_types_item.rb +45 -0
  1399. data/lib/samsara_api/types/webhooks_post_webhooks_response_body_version.rb +13 -0
  1400. data/lib/samsara_api/types/webhooks_post_webhooks_service_unavailable_error_response_body.rb +66 -0
  1401. data/lib/samsara_api/types/webhooks_post_webhooks_too_many_requests_error_response_body.rb +66 -0
  1402. data/lib/samsara_api/types/webhooks_post_webhooks_unauthorized_error_response_body.rb +66 -0
  1403. data/lib/samsara_api/types/work_order_attachment_object_response_body.rb +89 -0
  1404. data/lib/samsara_api/types/work_order_attachment_object_response_body_processing_status.rb +14 -0
  1405. data/lib/samsara_api/types/work_order_discount_object_request_body.rb +72 -0
  1406. data/lib/samsara_api/types/work_order_discount_object_response_body.rb +72 -0
  1407. data/lib/samsara_api/types/work_order_item_object_request_body.rb +67 -0
  1408. data/lib/samsara_api/types/work_order_item_object_request_body_type.rb +19 -0
  1409. data/lib/samsara_api/types/work_order_item_object_response_body.rb +67 -0
  1410. data/lib/samsara_api/types/work_order_item_object_response_body_type.rb +19 -0
  1411. data/lib/samsara_api/types/work_order_money_object_request_body.rb +64 -0
  1412. data/lib/samsara_api/types/work_order_money_object_response_body.rb +64 -0
  1413. data/lib/samsara_api/types/work_order_object_response_body.rb +257 -0
  1414. data/lib/samsara_api/types/work_order_object_response_body_category.rb +18 -0
  1415. data/lib/samsara_api/types/work_order_object_response_body_priority.rb +15 -0
  1416. data/lib/samsara_api/types/work_order_object_response_body_status.rb +22 -0
  1417. data/lib/samsara_api/types/work_order_tax_object_request_body.rb +73 -0
  1418. data/lib/samsara_api/types/work_order_tax_object_response_body.rb +73 -0
  1419. data/lib/samsara_api/types/workflow_address_event_with_geofence_object_response_body.rb +97 -0
  1420. data/lib/samsara_api/types/workflow_author_signature_object_response_body.rb +82 -0
  1421. data/lib/samsara_api/types/workflow_author_signature_object_response_body_type.rb +14 -0
  1422. data/lib/samsara_api/types/workflow_circle_response_body.rb +76 -0
  1423. data/lib/samsara_api/types/workflow_dvir_object_response_body.rb +184 -0
  1424. data/lib/samsara_api/types/workflow_dvir_object_response_body_safety_status.rb +15 -0
  1425. data/lib/samsara_api/types/workflow_dvir_object_response_body_type.rb +16 -0
  1426. data/lib/samsara_api/types/workflow_dvir_submitted_response_object_response_body.rb +93 -0
  1427. data/lib/samsara_api/types/workflow_geofence_event_response_object_response_body.rb +92 -0
  1428. data/lib/samsara_api/types/workflow_geofence_response_body.rb +92 -0
  1429. data/lib/samsara_api/types/workflow_incident_condition_object_response_body.rb +80 -0
  1430. data/lib/samsara_api/types/workflow_incident_details_object_response_body.rb +794 -0
  1431. data/lib/samsara_api/types/workflow_polygon_response_body.rb +65 -0
  1432. data/lib/samsara_api/types/workflow_signatory_user_object_response_body.rb +66 -0
  1433. data/lib/samsara_api/types/workflow_trigger_object_request_body.rb +158 -0
  1434. data/lib/samsara_api/types/workflow_trigger_object_response_body.rb +158 -0
  1435. data/lib/samsara_api/user_roles/client.rb +118 -0
  1436. data/lib/samsara_api/users/client.rb +515 -0
  1437. data/lib/samsara_api/users/types/create_user_request_auth_type.rb +17 -0
  1438. data/lib/samsara_api/users/types/update_user_request_auth_type.rb +17 -0
  1439. data/lib/samsara_api/v_1_messages/client.rb +230 -0
  1440. data/lib/samsara_api/vehicles/client.rb +817 -0
  1441. data/lib/samsara_api/vehicles/immobilizer/client.rb +142 -0
  1442. data/lib/samsara_api/vehicles/locations/client.rb +397 -0
  1443. data/lib/samsara_api/vehicles/stats/client.rb +1490 -0
  1444. data/lib/samsara_api/vehicles/stats/types/stats_feed_request_decorations_item.rb +59 -0
  1445. data/lib/samsara_api/vehicles/stats/types/stats_feed_request_types_item.rb +73 -0
  1446. data/lib/samsara_api/vehicles/stats/types/stats_history_request_decorations_item.rb +59 -0
  1447. data/lib/samsara_api/vehicles/stats/types/stats_history_request_types_item.rb +73 -0
  1448. data/lib/samsara_api/vehicles/stats/types/stats_list_request_types_item.rb +73 -0
  1449. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_1.rb +45 -0
  1450. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_10.rb +45 -0
  1451. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_11.rb +45 -0
  1452. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_12.rb +45 -0
  1453. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_13.rb +45 -0
  1454. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_2.rb +45 -0
  1455. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_3.rb +45 -0
  1456. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_4.rb +45 -0
  1457. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_5.rb +45 -0
  1458. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_6.rb +45 -0
  1459. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_7.rb +45 -0
  1460. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_8.rb +45 -0
  1461. data/lib/samsara_api/vehicles/types/update_vehicle_request_aux_input_type_9.rb +45 -0
  1462. data/lib/samsara_api/vehicles/types/update_vehicle_request_harsh_acceleration_setting_type.rb +25 -0
  1463. data/lib/samsara_api/webhooks/client.rb +545 -0
  1464. data/lib/samsara_api/webhooks/types/webhooks_patch_webhook_request_body_version.rb +18 -0
  1465. data/lib/samsara_api/webhooks/types/webhooks_post_webhooks_request_body_event_types_item.rb +47 -0
  1466. data/lib/samsara_api/webhooks/types/webhooks_post_webhooks_request_body_version.rb +18 -0
  1467. data/lib/samsara_api.rb +398 -0
  1468. data/lib/types_export.rb +1378 -0
  1469. metadata +1592 -0
@@ -0,0 +1,1490 @@
1
+ # frozen_string_literal: true
2
+ require_relative "../../../requests"
3
+ require_relative "types/stats_list_request_types_item"
4
+ require_relative "../../types/vehicle_stats_response"
5
+ require_relative "types/stats_feed_request_types_item"
6
+ require_relative "types/stats_feed_request_decorations_item"
7
+ require_relative "../../types/vehicle_stats_list_response"
8
+ require_relative "types/stats_history_request_types_item"
9
+ require_relative "types/stats_history_request_decorations_item"
10
+ require "async"
11
+ require "async"
12
+ require "async"
13
+ require_relative "../../../requests"
14
+
15
+ module Samsara
16
+ module Vehicles
17
+ class StatsClient
18
+ # @return [Samsara::RequestClient]
19
+ attr_reader :request_client
20
+
21
+
22
+ # @param request_client [Samsara::RequestClient]
23
+ # @return [Samsara::Vehicles::StatsClient]
24
+ def initialize(request_client:)
25
+ @request_client = request_client
26
+ end
27
+ # Returns the last known stats of all vehicles at the given `time`. If no `time`
28
+ # is specified, the current time is used.
29
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
30
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
31
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
32
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
33
+ # inaccuracies in the API documentation, please <a
34
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
35
+ # support team.
36
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
37
+ # category when creating or editing an API token. <a
38
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
39
+ # target="_blank">Learn More.</a>
40
+ #
41
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
42
+ # results. When present, this request will return the next page of results that
43
+ # occur immediately after the previous page of results.
44
+ # @param time [String] A filter on the data that returns the last known data points with timestamps
45
+ # less than or equal to this value. Defaults to now if not provided. Must be a
46
+ # string in RFC 3339 format. Millisecond precision and timezones are supported.
47
+ # (Example: `2020-01-27T07:06:25Z`).
48
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
49
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
50
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
51
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
52
+ # `tagIds=1234,5678`
53
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
54
+ # `vehicleIds=1234,5678`
55
+ # @param types [Samsara::Vehicles::Stats::Types::StatsListRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
56
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
57
+ # for more details.
58
+ # You may list ***up to 4*** types using comma-separated format. For example:
59
+ # `types=gps,engineStates,obdOdometerMeters`.
60
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
61
+ # For example, you could list
62
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
63
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
64
+ # count as their own individual types.
65
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
66
+ # millidegree Celsius.
67
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
68
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
69
+ # target="_blank">auxiliary inputs</a> for the vehicle.
70
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
71
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
72
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
73
+ # percentage points (e.g. `99001`, `49999`, etc).
74
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
75
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
76
+ # millidegree Celsius.
77
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
78
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
79
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
80
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
81
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
82
+ # Immobilizer Hardware versions (incl. HW-EI21).
83
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
84
+ # etc).
85
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
86
+ # - `engineRpm`: The revolutions per minute of the engine.
87
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
88
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
89
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
90
+ # etc).
91
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
92
+ # exists), and a reverse geocoded address.
93
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
94
+ # was installed based on GPS calculations.
95
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
96
+ # odometer cannot be pulled automatically. You must provide a manual odometer
97
+ # reading before this value is updated. Manual odometer readings can be provided
98
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
99
+ # <a
100
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
101
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
102
+ # will update as GPS trip data is gathered. Try combining with
103
+ # `obdOdometerMeters`.
104
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
105
+ # millidegree Celsius.
106
+ # - `nfcCardScans`: ID card scans.
107
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
108
+ # according to onboard diagnostics.
109
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
110
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
111
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
112
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
113
+ # vehicle.
114
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
115
+ # hybrid vehicles. Not all EV and HEVs may report this field.
116
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
117
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
118
+ # charging - 2.
119
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
120
+ # microwatt hours. Not all EV and HEVs may report this field.
121
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
122
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
123
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
124
+ # in milli amps. Not all EV and HEVs may report this field.
125
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
126
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
127
+ # this field.
128
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
129
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
130
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
131
+ # in milli volts. Not all EV and HEVs may report this field.
132
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
133
+ # in milli amps. Not all EV and HEVs may report this field.
134
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
135
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
136
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
137
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
138
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
139
+ # vehicles in meters. Not all EV and HEVs may report this field.
140
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
141
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
142
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
143
+ # time or distance.
144
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
145
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
146
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
147
+ # time or distance.
148
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
149
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
150
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
151
+ # time or distance.
152
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
153
+ # material spreader.
154
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
155
+ # spreader.
156
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
157
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
158
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
159
+ # mode’.
160
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
161
+ # read from the material spreader.
162
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
163
+ # from the material spreader.
164
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
165
+ # from the material spreader.
166
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
167
+ # material spreader. Note: this is separate from plow status defined via auxInput.
168
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
169
+ # or `Unbuckled`. (Beta only)
170
+ # @param request_options [Samsara::RequestOptions]
171
+ # @return [Samsara::Types::VehicleStatsResponse]
172
+ # @example
173
+ # api = Samsara::Client.new(
174
+ # base_url: "https://api.example.com",
175
+ # environment: Samsara::Environment::PRODUCTION_API,
176
+ # token: "YOUR_AUTH_TOKEN"
177
+ # )
178
+ # api.vehicles.stats.list
179
+ def list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, request_options: nil)
180
+ response = @request_client.conn.get do | req |
181
+ unless request_options&.timeout_in_seconds.nil?
182
+ req.options.timeout = request_options.timeout_in_seconds
183
+ end
184
+ unless request_options&.token.nil?
185
+ req.headers["Authorization"] = request_options.token
186
+ end
187
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
188
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "time": time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types }.compact
189
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
190
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
191
+ end
192
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats"
193
+ end
194
+ Samsara::Types::VehicleStatsResponse.from_json(json_object: response.body)
195
+ end
196
+ # Follow a feed of vehicle stats.
197
+ # Your first call to this endpoint will provide you with the most recent stats for
198
+ # each vehicle and an `endCursor`.
199
+ # You can the provide the `endCursor` value to the `after` query parameter to get
200
+ # all updates since the last call you made.
201
+ # If `hasNextPage` is `false`, no new data is immediately available. You should
202
+ # wait a minimum of 5 seconds making a subsequent request.
203
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
204
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
205
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
206
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
207
+ # inaccuracies in the API documentation, please <a
208
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
209
+ # support team.
210
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
211
+ # category when creating or editing an API token. <a
212
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
213
+ # target="_blank">Learn More.</a>
214
+ #
215
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
216
+ # results. When present, this request will return the next page of results that
217
+ # occur immediately after the previous page of results.
218
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
219
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
220
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
221
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
222
+ # `tagIds=1234,5678`
223
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
224
+ # `vehicleIds=1234,5678`
225
+ # @param types [Samsara::Vehicles::Stats::Types::StatsFeedRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
226
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
227
+ # for more details.
228
+ # You may list ***up to 4*** types using comma-separated format. For example:
229
+ # `types=gps,engineStates,obdOdometerMeters`.
230
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
231
+ # For example, you could list
232
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
233
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
234
+ # count as their own individual types.
235
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
236
+ # millidegree Celsius.
237
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
238
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
239
+ # target="_blank">auxiliary inputs</a> for the vehicle.
240
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
241
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
242
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
243
+ # percentage points (e.g. `99001`, `49999`, etc).
244
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
245
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
246
+ # millidegree Celsius.
247
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
248
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
249
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
250
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
251
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
252
+ # Immobilizer Hardware versions (incl. HW-EI21).
253
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
254
+ # etc).
255
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
256
+ # - `engineRpm`: The revolutions per minute of the engine.
257
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
258
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
259
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
260
+ # etc).
261
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
262
+ # exists), and a reverse geocoded address.
263
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
264
+ # was installed based on GPS calculations.
265
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
266
+ # odometer cannot be pulled automatically. You must provide a manual odometer
267
+ # reading before this value is updated. Manual odometer readings can be provided
268
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
269
+ # <a
270
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
271
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
272
+ # will update as GPS trip data is gathered. Try combining with
273
+ # `obdOdometerMeters`.
274
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
275
+ # millidegree Celsius.
276
+ # - `nfcCardScans`: ID card scans.
277
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
278
+ # according to onboard diagnostics.
279
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
280
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
281
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
282
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
283
+ # vehicle.
284
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
285
+ # hybrid vehicles. Not all EV and HEVs may report this field.
286
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
287
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
288
+ # charging - 2.
289
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
290
+ # microwatt hours. Not all EV and HEVs may report this field.
291
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
292
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
293
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
294
+ # in milli amps. Not all EV and HEVs may report this field.
295
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
296
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
297
+ # this field.
298
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
299
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
300
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
301
+ # in milli volts. Not all EV and HEVs may report this field.
302
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
303
+ # in milli amps. Not all EV and HEVs may report this field.
304
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
305
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
306
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
307
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
308
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
309
+ # vehicles in meters. Not all EV and HEVs may report this field.
310
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
311
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
312
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
313
+ # time or distance.
314
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
315
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
316
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
317
+ # time or distance.
318
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
319
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
320
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
321
+ # time or distance.
322
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
323
+ # material spreader.
324
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
325
+ # spreader.
326
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
327
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
328
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
329
+ # mode’.
330
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
331
+ # read from the material spreader.
332
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
333
+ # from the material spreader.
334
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
335
+ # from the material spreader.
336
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
337
+ # material spreader. Note: this is separate from plow status defined via auxInput.
338
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
339
+ # or `Unbuckled`. (Beta only)
340
+ # @param decorations [Samsara::Vehicles::Stats::Types::StatsFeedRequestDecorationsItem] Decorations to add to the primary stats listed in the `types` parameter. For
341
+ # example, if you wish to know the vehicle's location whenever the engine changes
342
+ # state, you may set `types=engineStates&decorations=gps`.
343
+ # You may list ***up to 2*** decorations using comma-separated format. If multiple
344
+ # stats are listed in the `types` parameter, the decorations will be added to each
345
+ # one. For example:
346
+ # `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents`
347
+ # will list GPS and fuel decorations for each engine state change, each odometer
348
+ # reading, and each fault code. See the <a
349
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
350
+ # for more details.
351
+ # Note that decorations may significantly increase the response payload size.
352
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
353
+ # millidegree Celsius.
354
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
355
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
356
+ # target="_blank">auxiliary inputs</a> for the vehicle.
357
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
358
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
359
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
360
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
361
+ # millidegree Celsius.
362
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
363
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
364
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
365
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
366
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
367
+ # Immobilizer Hardware versions (incl. HW-EI21).
368
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
369
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
370
+ # etc).
371
+ # - `engineRpm`: The revolutions per minute of the engine.
372
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
373
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
374
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
375
+ # etc).
376
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
377
+ # exists), and a reverse geocoded address.
378
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
379
+ # was installed based on GPS calculations.
380
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
381
+ # millidegree Celsius.
382
+ # - `nfcCardScans`: ID card scans.
383
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
384
+ # according to onboard diagnostics.
385
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
386
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
387
+ # for this stat type will be omitted.
388
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
389
+ # vehicle.
390
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
391
+ # hybrid vehicles. Not all EV and HEVs may report this field.
392
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
393
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
394
+ # charging - 2.
395
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
396
+ # microwatt hours. Not all EV and HEVs may report this field.
397
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
398
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
399
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
400
+ # in milli amps. Not all EV and HEVs may report this field.
401
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
402
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
403
+ # this field.
404
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
405
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
406
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
407
+ # in milli volts. Not all EV and HEVs may report this field.
408
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
409
+ # in milli amps. Not all EV and HEVs may report this field.
410
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
411
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
412
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
413
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
414
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
415
+ # vehicles in meters. Not all EV and HEVs may report this field.
416
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
417
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
418
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
419
+ # time or distance.
420
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
421
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
422
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
423
+ # time or distance.
424
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
425
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
426
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
427
+ # time or distance.
428
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
429
+ # material spreader.
430
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
431
+ # spreader.
432
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
433
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
434
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
435
+ # mode’.
436
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
437
+ # read from the material spreader.
438
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
439
+ # from the material spreader.
440
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
441
+ # from the material spreader.
442
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
443
+ # material spreader. Note: this is separate from plow status defined via auxInput.
444
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
445
+ # or `Unbuckled`. (Beta only)
446
+ # @param request_options [Samsara::RequestOptions]
447
+ # @return [Samsara::Types::VehicleStatsListResponse]
448
+ # @example
449
+ # api = Samsara::Client.new(
450
+ # base_url: "https://api.example.com",
451
+ # environment: Samsara::Environment::PRODUCTION_API,
452
+ # token: "YOUR_AUTH_TOKEN"
453
+ # )
454
+ # api.vehicles.stats.feed
455
+ def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil)
456
+ response = @request_client.conn.get do | req |
457
+ unless request_options&.timeout_in_seconds.nil?
458
+ req.options.timeout = request_options.timeout_in_seconds
459
+ end
460
+ unless request_options&.token.nil?
461
+ req.headers["Authorization"] = request_options.token
462
+ end
463
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
464
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.compact
465
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
466
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
467
+ end
468
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats/feed"
469
+ end
470
+ Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
471
+ end
472
+ # Returns vehicle stats during the given time range for all vehicles. This can be
473
+ # optionally filtered by tags or specific vehicle IDs.
474
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
475
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
476
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
477
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
478
+ # inaccuracies in the API documentation, please <a
479
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
480
+ # support team.
481
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
482
+ # category when creating or editing an API token. <a
483
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
484
+ # target="_blank">Learn More.</a>
485
+ #
486
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
487
+ # results. When present, this request will return the next page of results that
488
+ # occur immediately after the previous page of results.
489
+ # @param start_time [String] A start time in RFC 3339 format. Millisecond precision and timezones are
490
+ # supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR
491
+ # 2015-09-15T14:00:12-04:00).
492
+ # @param end_time [String] An end time in RFC 3339 format. Millisecond precision and timezones are
493
+ # supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR
494
+ # 2015-09-15T14:00:12-04:00).
495
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
496
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
497
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
498
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
499
+ # `tagIds=1234,5678`
500
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
501
+ # `vehicleIds=1234,5678`
502
+ # @param types [Samsara::Vehicles::Stats::Types::StatsHistoryRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
503
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
504
+ # for more details.
505
+ # You may list ***up to 4*** types using comma-separated format. For example:
506
+ # `types=gps,engineStates,obdOdometerMeters`.
507
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
508
+ # For example, you could list
509
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
510
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
511
+ # count as their own individual types.
512
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
513
+ # millidegree Celsius.
514
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
515
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
516
+ # target="_blank">auxiliary inputs</a> for the vehicle.
517
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
518
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
519
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
520
+ # percentage points (e.g. `99001`, `49999`, etc).
521
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
522
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
523
+ # millidegree Celsius.
524
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
525
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
526
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
527
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
528
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
529
+ # Immobilizer Hardware versions (incl. HW-EI21).
530
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
531
+ # etc).
532
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
533
+ # - `engineRpm`: The revolutions per minute of the engine.
534
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
535
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
536
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
537
+ # etc).
538
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
539
+ # exists), and a reverse geocoded address.
540
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
541
+ # was installed based on GPS calculations.
542
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
543
+ # odometer cannot be pulled automatically. You must provide a manual odometer
544
+ # reading before this value is updated. Manual odometer readings can be provided
545
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
546
+ # <a
547
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
548
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
549
+ # will update as GPS trip data is gathered. Try combining with
550
+ # `obdOdometerMeters`.
551
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
552
+ # millidegree Celsius.
553
+ # - `nfcCardScans`: ID card scans.
554
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
555
+ # according to onboard diagnostics.
556
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
557
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
558
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
559
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
560
+ # vehicle.
561
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
562
+ # hybrid vehicles. Not all EV and HEVs may report this field.
563
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
564
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
565
+ # charging - 2.
566
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
567
+ # microwatt hours. Not all EV and HEVs may report this field.
568
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
569
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
570
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
571
+ # in milli amps. Not all EV and HEVs may report this field.
572
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
573
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
574
+ # this field.
575
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
576
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
577
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
578
+ # in milli volts. Not all EV and HEVs may report this field.
579
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
580
+ # in milli amps. Not all EV and HEVs may report this field.
581
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
582
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
583
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
584
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
585
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
586
+ # vehicles in meters. Not all EV and HEVs may report this field.
587
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
588
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
589
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
590
+ # time or distance.
591
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
592
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
593
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
594
+ # time or distance.
595
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
596
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
597
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
598
+ # time or distance.
599
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
600
+ # material spreader.
601
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
602
+ # spreader.
603
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
604
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
605
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
606
+ # mode’.
607
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
608
+ # read from the material spreader.
609
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
610
+ # from the material spreader.
611
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
612
+ # from the material spreader.
613
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
614
+ # material spreader. Note: this is separate from plow status defined via auxInput.
615
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
616
+ # or `Unbuckled`. (Beta only)
617
+ # @param decorations [Samsara::Vehicles::Stats::Types::StatsHistoryRequestDecorationsItem] Decorations to add to the primary stats listed in the `types` parameter. For
618
+ # example, if you wish to know the vehicle's location whenever the engine changes
619
+ # state, you may set `types=engineStates&decorations=gps`.
620
+ # You may list ***up to 2*** decorations using comma-separated format. If multiple
621
+ # stats are listed in the `types` parameter, the decorations will be added to each
622
+ # one. For example:
623
+ # `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents`
624
+ # will list GPS and fuel decorations for each engine state change, each odometer
625
+ # reading, and each fault code. See the <a
626
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
627
+ # for more details.
628
+ # Note that decorations may significantly increase the response payload size.
629
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
630
+ # millidegree Celsius.
631
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
632
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
633
+ # target="_blank">auxiliary inputs</a> for the vehicle.
634
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
635
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
636
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
637
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
638
+ # millidegree Celsius.
639
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
640
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
641
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
642
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
643
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
644
+ # Immobilizer Hardware versions (incl. HW-EI21).
645
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
646
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
647
+ # etc).
648
+ # - `engineRpm`: The revolutions per minute of the engine.
649
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
650
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
651
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
652
+ # etc).
653
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
654
+ # exists), and a reverse geocoded address.
655
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
656
+ # was installed based on GPS calculations.
657
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
658
+ # millidegree Celsius.
659
+ # - `nfcCardScans`: ID card scans.
660
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
661
+ # according to onboard diagnostics.
662
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
663
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
664
+ # for this stat type will be omitted.
665
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
666
+ # vehicle.
667
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
668
+ # hybrid vehicles. Not all EV and HEVs may report this field.
669
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
670
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
671
+ # charging - 2.
672
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
673
+ # microwatt hours. Not all EV and HEVs may report this field.
674
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
675
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
676
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
677
+ # in milli amps. Not all EV and HEVs may report this field.
678
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
679
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
680
+ # this field.
681
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
682
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
683
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
684
+ # in milli volts. Not all EV and HEVs may report this field.
685
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
686
+ # in milli amps. Not all EV and HEVs may report this field.
687
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
688
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
689
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
690
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
691
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
692
+ # vehicles in meters. Not all EV and HEVs may report this field.
693
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
694
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
695
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
696
+ # time or distance.
697
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
698
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
699
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
700
+ # time or distance.
701
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
702
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
703
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
704
+ # time or distance.
705
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
706
+ # material spreader.
707
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
708
+ # spreader.
709
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
710
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
711
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
712
+ # mode’.
713
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
714
+ # read from the material spreader.
715
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
716
+ # from the material spreader.
717
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
718
+ # from the material spreader.
719
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
720
+ # material spreader. Note: this is separate from plow status defined via auxInput.
721
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
722
+ # or `Unbuckled`. (Beta only)
723
+ # @param request_options [Samsara::RequestOptions]
724
+ # @return [Samsara::Types::VehicleStatsListResponse]
725
+ # @example
726
+ # api = Samsara::Client.new(
727
+ # base_url: "https://api.example.com",
728
+ # environment: Samsara::Environment::PRODUCTION_API,
729
+ # token: "YOUR_AUTH_TOKEN"
730
+ # )
731
+ # api.vehicles.stats.history(start_time: "startTime", end_time: "endTime")
732
+ def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil)
733
+ response = @request_client.conn.get do | req |
734
+ unless request_options&.timeout_in_seconds.nil?
735
+ req.options.timeout = request_options.timeout_in_seconds
736
+ end
737
+ unless request_options&.token.nil?
738
+ req.headers["Authorization"] = request_options.token
739
+ end
740
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
741
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.compact
742
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
743
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
744
+ end
745
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats/history"
746
+ end
747
+ Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
748
+ end
749
+ end
750
+ class AsyncStatsClient
751
+ # @return [Samsara::AsyncRequestClient]
752
+ attr_reader :request_client
753
+
754
+
755
+ # @param request_client [Samsara::RequestClient]
756
+ # @return [Samsara::Vehicles::AsyncStatsClient]
757
+ def initialize(request_client:)
758
+ @request_client = request_client
759
+ end
760
+ # Returns the last known stats of all vehicles at the given `time`. If no `time`
761
+ # is specified, the current time is used.
762
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
763
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
764
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
765
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
766
+ # inaccuracies in the API documentation, please <a
767
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
768
+ # support team.
769
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
770
+ # category when creating or editing an API token. <a
771
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
772
+ # target="_blank">Learn More.</a>
773
+ #
774
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
775
+ # results. When present, this request will return the next page of results that
776
+ # occur immediately after the previous page of results.
777
+ # @param time [String] A filter on the data that returns the last known data points with timestamps
778
+ # less than or equal to this value. Defaults to now if not provided. Must be a
779
+ # string in RFC 3339 format. Millisecond precision and timezones are supported.
780
+ # (Example: `2020-01-27T07:06:25Z`).
781
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
782
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
783
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
784
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
785
+ # `tagIds=1234,5678`
786
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
787
+ # `vehicleIds=1234,5678`
788
+ # @param types [Samsara::Vehicles::Stats::Types::StatsListRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
789
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
790
+ # for more details.
791
+ # You may list ***up to 4*** types using comma-separated format. For example:
792
+ # `types=gps,engineStates,obdOdometerMeters`.
793
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
794
+ # For example, you could list
795
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
796
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
797
+ # count as their own individual types.
798
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
799
+ # millidegree Celsius.
800
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
801
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
802
+ # target="_blank">auxiliary inputs</a> for the vehicle.
803
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
804
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
805
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
806
+ # percentage points (e.g. `99001`, `49999`, etc).
807
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
808
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
809
+ # millidegree Celsius.
810
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
811
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
812
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
813
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
814
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
815
+ # Immobilizer Hardware versions (incl. HW-EI21).
816
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
817
+ # etc).
818
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
819
+ # - `engineRpm`: The revolutions per minute of the engine.
820
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
821
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
822
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
823
+ # etc).
824
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
825
+ # exists), and a reverse geocoded address.
826
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
827
+ # was installed based on GPS calculations.
828
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
829
+ # odometer cannot be pulled automatically. You must provide a manual odometer
830
+ # reading before this value is updated. Manual odometer readings can be provided
831
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
832
+ # <a
833
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
834
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
835
+ # will update as GPS trip data is gathered. Try combining with
836
+ # `obdOdometerMeters`.
837
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
838
+ # millidegree Celsius.
839
+ # - `nfcCardScans`: ID card scans.
840
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
841
+ # according to onboard diagnostics.
842
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
843
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
844
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
845
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
846
+ # vehicle.
847
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
848
+ # hybrid vehicles. Not all EV and HEVs may report this field.
849
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
850
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
851
+ # charging - 2.
852
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
853
+ # microwatt hours. Not all EV and HEVs may report this field.
854
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
855
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
856
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
857
+ # in milli amps. Not all EV and HEVs may report this field.
858
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
859
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
860
+ # this field.
861
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
862
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
863
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
864
+ # in milli volts. Not all EV and HEVs may report this field.
865
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
866
+ # in milli amps. Not all EV and HEVs may report this field.
867
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
868
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
869
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
870
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
871
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
872
+ # vehicles in meters. Not all EV and HEVs may report this field.
873
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
874
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
875
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
876
+ # time or distance.
877
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
878
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
879
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
880
+ # time or distance.
881
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
882
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
883
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
884
+ # time or distance.
885
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
886
+ # material spreader.
887
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
888
+ # spreader.
889
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
890
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
891
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
892
+ # mode’.
893
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
894
+ # read from the material spreader.
895
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
896
+ # from the material spreader.
897
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
898
+ # from the material spreader.
899
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
900
+ # material spreader. Note: this is separate from plow status defined via auxInput.
901
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
902
+ # or `Unbuckled`. (Beta only)
903
+ # @param request_options [Samsara::RequestOptions]
904
+ # @return [Samsara::Types::VehicleStatsResponse]
905
+ # @example
906
+ # api = Samsara::Client.new(
907
+ # base_url: "https://api.example.com",
908
+ # environment: Samsara::Environment::PRODUCTION_API,
909
+ # token: "YOUR_AUTH_TOKEN"
910
+ # )
911
+ # api.vehicles.stats.list
912
+ def list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, request_options: nil)
913
+ Async do
914
+ response = @request_client.conn.get do | req |
915
+ unless request_options&.timeout_in_seconds.nil?
916
+ req.options.timeout = request_options.timeout_in_seconds
917
+ end
918
+ unless request_options&.token.nil?
919
+ req.headers["Authorization"] = request_options.token
920
+ end
921
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
922
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "time": time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types }.compact
923
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
924
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
925
+ end
926
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats"
927
+ end
928
+ Samsara::Types::VehicleStatsResponse.from_json(json_object: response.body)
929
+ end
930
+ end
931
+ # Follow a feed of vehicle stats.
932
+ # Your first call to this endpoint will provide you with the most recent stats for
933
+ # each vehicle and an `endCursor`.
934
+ # You can the provide the `endCursor` value to the `after` query parameter to get
935
+ # all updates since the last call you made.
936
+ # If `hasNextPage` is `false`, no new data is immediately available. You should
937
+ # wait a minimum of 5 seconds making a subsequent request.
938
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
939
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
940
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
941
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
942
+ # inaccuracies in the API documentation, please <a
943
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
944
+ # support team.
945
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
946
+ # category when creating or editing an API token. <a
947
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
948
+ # target="_blank">Learn More.</a>
949
+ #
950
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
951
+ # results. When present, this request will return the next page of results that
952
+ # occur immediately after the previous page of results.
953
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
954
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
955
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
956
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
957
+ # `tagIds=1234,5678`
958
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
959
+ # `vehicleIds=1234,5678`
960
+ # @param types [Samsara::Vehicles::Stats::Types::StatsFeedRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
961
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
962
+ # for more details.
963
+ # You may list ***up to 4*** types using comma-separated format. For example:
964
+ # `types=gps,engineStates,obdOdometerMeters`.
965
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
966
+ # For example, you could list
967
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
968
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
969
+ # count as their own individual types.
970
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
971
+ # millidegree Celsius.
972
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
973
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
974
+ # target="_blank">auxiliary inputs</a> for the vehicle.
975
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
976
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
977
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
978
+ # percentage points (e.g. `99001`, `49999`, etc).
979
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
980
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
981
+ # millidegree Celsius.
982
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
983
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
984
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
985
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
986
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
987
+ # Immobilizer Hardware versions (incl. HW-EI21).
988
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
989
+ # etc).
990
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
991
+ # - `engineRpm`: The revolutions per minute of the engine.
992
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
993
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
994
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
995
+ # etc).
996
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
997
+ # exists), and a reverse geocoded address.
998
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
999
+ # was installed based on GPS calculations.
1000
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
1001
+ # odometer cannot be pulled automatically. You must provide a manual odometer
1002
+ # reading before this value is updated. Manual odometer readings can be provided
1003
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
1004
+ # <a
1005
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
1006
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
1007
+ # will update as GPS trip data is gathered. Try combining with
1008
+ # `obdOdometerMeters`.
1009
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
1010
+ # millidegree Celsius.
1011
+ # - `nfcCardScans`: ID card scans.
1012
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
1013
+ # according to onboard diagnostics.
1014
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
1015
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
1016
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
1017
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
1018
+ # vehicle.
1019
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
1020
+ # hybrid vehicles. Not all EV and HEVs may report this field.
1021
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
1022
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
1023
+ # charging - 2.
1024
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
1025
+ # microwatt hours. Not all EV and HEVs may report this field.
1026
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
1027
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
1028
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
1029
+ # in milli amps. Not all EV and HEVs may report this field.
1030
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
1031
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
1032
+ # this field.
1033
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
1034
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
1035
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
1036
+ # in milli volts. Not all EV and HEVs may report this field.
1037
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
1038
+ # in milli amps. Not all EV and HEVs may report this field.
1039
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
1040
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
1041
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
1042
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
1043
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
1044
+ # vehicles in meters. Not all EV and HEVs may report this field.
1045
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
1046
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1047
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1048
+ # time or distance.
1049
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
1050
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1051
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1052
+ # time or distance.
1053
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
1054
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1055
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1056
+ # time or distance.
1057
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
1058
+ # material spreader.
1059
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
1060
+ # spreader.
1061
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
1062
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
1063
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
1064
+ # mode’.
1065
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
1066
+ # read from the material spreader.
1067
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
1068
+ # from the material spreader.
1069
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
1070
+ # from the material spreader.
1071
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
1072
+ # material spreader. Note: this is separate from plow status defined via auxInput.
1073
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
1074
+ # or `Unbuckled`. (Beta only)
1075
+ # @param decorations [Samsara::Vehicles::Stats::Types::StatsFeedRequestDecorationsItem] Decorations to add to the primary stats listed in the `types` parameter. For
1076
+ # example, if you wish to know the vehicle's location whenever the engine changes
1077
+ # state, you may set `types=engineStates&decorations=gps`.
1078
+ # You may list ***up to 2*** decorations using comma-separated format. If multiple
1079
+ # stats are listed in the `types` parameter, the decorations will be added to each
1080
+ # one. For example:
1081
+ # `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents`
1082
+ # will list GPS and fuel decorations for each engine state change, each odometer
1083
+ # reading, and each fault code. See the <a
1084
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
1085
+ # for more details.
1086
+ # Note that decorations may significantly increase the response payload size.
1087
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
1088
+ # millidegree Celsius.
1089
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
1090
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
1091
+ # target="_blank">auxiliary inputs</a> for the vehicle.
1092
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
1093
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
1094
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
1095
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
1096
+ # millidegree Celsius.
1097
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
1098
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
1099
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
1100
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
1101
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
1102
+ # Immobilizer Hardware versions (incl. HW-EI21).
1103
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
1104
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
1105
+ # etc).
1106
+ # - `engineRpm`: The revolutions per minute of the engine.
1107
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
1108
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
1109
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
1110
+ # etc).
1111
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
1112
+ # exists), and a reverse geocoded address.
1113
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
1114
+ # was installed based on GPS calculations.
1115
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
1116
+ # millidegree Celsius.
1117
+ # - `nfcCardScans`: ID card scans.
1118
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
1119
+ # according to onboard diagnostics.
1120
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
1121
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
1122
+ # for this stat type will be omitted.
1123
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
1124
+ # vehicle.
1125
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
1126
+ # hybrid vehicles. Not all EV and HEVs may report this field.
1127
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
1128
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
1129
+ # charging - 2.
1130
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
1131
+ # microwatt hours. Not all EV and HEVs may report this field.
1132
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
1133
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
1134
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
1135
+ # in milli amps. Not all EV and HEVs may report this field.
1136
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
1137
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
1138
+ # this field.
1139
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
1140
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
1141
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
1142
+ # in milli volts. Not all EV and HEVs may report this field.
1143
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
1144
+ # in milli amps. Not all EV and HEVs may report this field.
1145
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
1146
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
1147
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
1148
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
1149
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
1150
+ # vehicles in meters. Not all EV and HEVs may report this field.
1151
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
1152
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1153
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1154
+ # time or distance.
1155
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
1156
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1157
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1158
+ # time or distance.
1159
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
1160
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1161
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1162
+ # time or distance.
1163
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
1164
+ # material spreader.
1165
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
1166
+ # spreader.
1167
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
1168
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
1169
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
1170
+ # mode’.
1171
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
1172
+ # read from the material spreader.
1173
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
1174
+ # from the material spreader.
1175
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
1176
+ # from the material spreader.
1177
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
1178
+ # material spreader. Note: this is separate from plow status defined via auxInput.
1179
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
1180
+ # or `Unbuckled`. (Beta only)
1181
+ # @param request_options [Samsara::RequestOptions]
1182
+ # @return [Samsara::Types::VehicleStatsListResponse]
1183
+ # @example
1184
+ # api = Samsara::Client.new(
1185
+ # base_url: "https://api.example.com",
1186
+ # environment: Samsara::Environment::PRODUCTION_API,
1187
+ # token: "YOUR_AUTH_TOKEN"
1188
+ # )
1189
+ # api.vehicles.stats.feed
1190
+ def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil)
1191
+ Async do
1192
+ response = @request_client.conn.get do | req |
1193
+ unless request_options&.timeout_in_seconds.nil?
1194
+ req.options.timeout = request_options.timeout_in_seconds
1195
+ end
1196
+ unless request_options&.token.nil?
1197
+ req.headers["Authorization"] = request_options.token
1198
+ end
1199
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
1200
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.compact
1201
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
1202
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
1203
+ end
1204
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats/feed"
1205
+ end
1206
+ Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
1207
+ end
1208
+ end
1209
+ # Returns vehicle stats during the given time range for all vehicles. This can be
1210
+ # optionally filtered by tags or specific vehicle IDs.
1211
+ # Related guide: <a href="/docs/telematics" target="_blank">Telematics</a>.
1212
+ # **Submit Feedback**: Likes, dislikes, and API feature requests should be filed
1213
+ # as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69"
1214
+ # target="_blank">API feedback form</a>. If you encountered an issue or noticed
1215
+ # inaccuracies in the API documentation, please <a
1216
+ # href="https://www.samsara.com/help" target="_blank">submit a case</a> to our
1217
+ # support team.
1218
+ # To use this endpoint, select **Read Vehicle Statistics** under the Vehicles
1219
+ # category when creating or editing an API token. <a
1220
+ # href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens"
1221
+ # target="_blank">Learn More.</a>
1222
+ #
1223
+ # @param after [String] If specified, this should be the endCursor value from the previous page of
1224
+ # results. When present, this request will return the next page of results that
1225
+ # occur immediately after the previous page of results.
1226
+ # @param start_time [String] A start time in RFC 3339 format. Millisecond precision and timezones are
1227
+ # supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR
1228
+ # 2015-09-15T14:00:12-04:00).
1229
+ # @param end_time [String] An end time in RFC 3339 format. Millisecond precision and timezones are
1230
+ # supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR
1231
+ # 2015-09-15T14:00:12-04:00).
1232
+ # @param parent_tag_ids [String] A filter on the data based on this comma-separated list of parent tag IDs, for
1233
+ # use by orgs with tag hierarchies. Specifying a parent tag will implicitly
1234
+ # include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
1235
+ # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
1236
+ # `tagIds=1234,5678`
1237
+ # @param vehicle_ids [String] A filter on the data based on this comma-separated list of vehicle IDs. Example:
1238
+ # `vehicleIds=1234,5678`
1239
+ # @param types [Samsara::Vehicles::Stats::Types::StatsHistoryRequestTypesItem] The stat types you want this endpoint to return information on. See also the <a
1240
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
1241
+ # for more details.
1242
+ # You may list ***up to 4*** types using comma-separated format. For example:
1243
+ # `types=gps,engineStates,obdOdometerMeters`.
1244
+ # *Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3.
1245
+ # For example, you could list
1246
+ # `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3`
1247
+ # and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still
1248
+ # count as their own individual types.
1249
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
1250
+ # millidegree Celsius.
1251
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
1252
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
1253
+ # target="_blank">auxiliary inputs</a> for the vehicle.
1254
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
1255
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
1256
+ # - `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli
1257
+ # percentage points (e.g. `99001`, `49999`, etc).
1258
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
1259
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
1260
+ # millidegree Celsius.
1261
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
1262
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
1263
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
1264
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
1265
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
1266
+ # Immobilizer Hardware versions (incl. HW-EI21).
1267
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
1268
+ # etc).
1269
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
1270
+ # - `engineRpm`: The revolutions per minute of the engine.
1271
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
1272
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
1273
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
1274
+ # etc).
1275
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
1276
+ # exists), and a reverse geocoded address.
1277
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
1278
+ # was installed based on GPS calculations.
1279
+ # - `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD
1280
+ # odometer cannot be pulled automatically. You must provide a manual odometer
1281
+ # reading before this value is updated. Manual odometer readings can be provided
1282
+ # via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the
1283
+ # <a
1284
+ # "https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading"
1285
+ # target="_blank">cloud dasbhoard</a>. Odometer readings that are manually set
1286
+ # will update as GPS trip data is gathered. Try combining with
1287
+ # `obdOdometerMeters`.
1288
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
1289
+ # millidegree Celsius.
1290
+ # - `nfcCardScans`: ID card scans.
1291
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
1292
+ # according to onboard diagnostics.
1293
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
1294
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
1295
+ # for this stat type will be omitted. Try combining with `gpsOdometerMeters`.
1296
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
1297
+ # vehicle.
1298
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
1299
+ # hybrid vehicles. Not all EV and HEVs may report this field.
1300
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
1301
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
1302
+ # charging - 2.
1303
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
1304
+ # microwatt hours. Not all EV and HEVs may report this field.
1305
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
1306
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
1307
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
1308
+ # in milli amps. Not all EV and HEVs may report this field.
1309
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
1310
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
1311
+ # this field.
1312
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
1313
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
1314
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
1315
+ # in milli volts. Not all EV and HEVs may report this field.
1316
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
1317
+ # in milli amps. Not all EV and HEVs may report this field.
1318
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
1319
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
1320
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
1321
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
1322
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
1323
+ # vehicles in meters. Not all EV and HEVs may report this field.
1324
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
1325
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1326
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1327
+ # time or distance.
1328
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
1329
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1330
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1331
+ # time or distance.
1332
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
1333
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1334
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1335
+ # time or distance.
1336
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
1337
+ # material spreader.
1338
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
1339
+ # spreader.
1340
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
1341
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
1342
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
1343
+ # mode’.
1344
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
1345
+ # read from the material spreader.
1346
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
1347
+ # from the material spreader.
1348
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
1349
+ # from the material spreader.
1350
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
1351
+ # material spreader. Note: this is separate from plow status defined via auxInput.
1352
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
1353
+ # or `Unbuckled`. (Beta only)
1354
+ # @param decorations [Samsara::Vehicles::Stats::Types::StatsHistoryRequestDecorationsItem] Decorations to add to the primary stats listed in the `types` parameter. For
1355
+ # example, if you wish to know the vehicle's location whenever the engine changes
1356
+ # state, you may set `types=engineStates&decorations=gps`.
1357
+ # You may list ***up to 2*** decorations using comma-separated format. If multiple
1358
+ # stats are listed in the `types` parameter, the decorations will be added to each
1359
+ # one. For example:
1360
+ # `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents`
1361
+ # will list GPS and fuel decorations for each engine state change, each odometer
1362
+ # reading, and each fault code. See the <a
1363
+ # href="/docs/telematics#query-parameters" target="_blank">Telematics</a> guide
1364
+ # for more details.
1365
+ # Note that decorations may significantly increase the response payload size.
1366
+ # - `ambientAirTemperatureMilliC`: The ambient air temperature reading in
1367
+ # millidegree Celsius.
1368
+ # - `auxInput1`-`auxInput13`: Stat events from the <a
1369
+ # href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs"
1370
+ # target="_blank">auxiliary inputs</a> for the vehicle.
1371
+ # - `batteryMilliVolts`: The vehicle battery voltage reading.
1372
+ # - `barometricPressurePa`: The barometric pressure reading in pascals.
1373
+ # - `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.
1374
+ # - `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in
1375
+ # millidegree Celsius.
1376
+ # - `engineImmobilizer`: The state of the engine immobilizer - Valid values:
1377
+ # `ignition_disabled`, `ignition_enabled`. This stat type will only return states
1378
+ # of our first Engine Immobilizer Hardware (ACC-EI). Please use <a
1379
+ # href="https://developers.samsara.com/reference/getengineimmobilizerstates"
1380
+ # target="_blank">Get engine immobilizer states</a> to get states for both Engine
1381
+ # Immobilizer Hardware versions (incl. HW-EI21).
1382
+ # - `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.
1383
+ # - `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`,
1384
+ # etc).
1385
+ # - `engineRpm`: The revolutions per minute of the engine.
1386
+ # - `engineStates`: The state of the engine (`Off`, `On`, `Idle`).
1387
+ # - `faultCodes`: The diagnostic fault codes for the vehicle.
1388
+ # - `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`,
1389
+ # etc).
1390
+ # - `gps`: GPS data including lat/long, heading, speed, address book entry (if
1391
+ # exists), and a reverse geocoded address.
1392
+ # - `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway
1393
+ # was installed based on GPS calculations.
1394
+ # - `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in
1395
+ # millidegree Celsius.
1396
+ # - `nfcCardScans`: ID card scans.
1397
+ # - `obdEngineSeconds`: The cumulative number of seconds the engine has run
1398
+ # according to onboard diagnostics.
1399
+ # - `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If
1400
+ # Samsara does not have diagnostic coverage for a particular vehicle, the value
1401
+ # for this stat type will be omitted.
1402
+ # - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the
1403
+ # vehicle.
1404
+ # - `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and
1405
+ # hybrid vehicles. Not all EV and HEVs may report this field.
1406
+ # - `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all
1407
+ # EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1,
1408
+ # charging - 2.
1409
+ # - `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in
1410
+ # microwatt hours. Not all EV and HEVs may report this field.
1411
+ # - `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid
1412
+ # vehicles in milli volts. Not all EV and HEVs may report this field.
1413
+ # - `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles
1414
+ # in milli amps. Not all EV and HEVs may report this field.
1415
+ # - `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for
1416
+ # electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report
1417
+ # this field.
1418
+ # - `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid
1419
+ # vehicles in microwatt hours. Not all EV and HEVs may report this field.
1420
+ # - `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles
1421
+ # in milli volts. Not all EV and HEVs may report this field.
1422
+ # - `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles
1423
+ # in milli amps. Not all EV and HEVs may report this field.
1424
+ # - `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health
1425
+ # for electric and hybrid vehicles. Not all EV and HEVs may report this field.
1426
+ # - `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric
1427
+ # and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
1428
+ # - `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid
1429
+ # vehicles in meters. Not all EV and HEVs may report this field.
1430
+ # - `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter,
1431
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1432
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1433
+ # time or distance.
1434
+ # - `spreaderGranularRate`: Granular spread rate reading in milliliters per meter,
1435
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1436
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1437
+ # time or distance.
1438
+ # - `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter,
1439
+ # read from the material spreader. Unfiltered live stats are supplied as-read from
1440
+ # the Material Spreader unit. Readings do not consider total spread rate(s) over
1441
+ # time or distance.
1442
+ # - `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from
1443
+ # material spreader.
1444
+ # - `spreaderRoadTemp`: Road temperature reading in milli celsius from material
1445
+ # spreader.
1446
+ # - `spreaderOnState`: Whether vehicle spreader is enabled.
1447
+ # - `spreaderActive`: Whether vehicle is actively spreading any material.
1448
+ # - `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast
1449
+ # mode’.
1450
+ # - `spreaderGranularName`: Name of most recent type of granular material spread,
1451
+ # read from the material spreader.
1452
+ # - `spreaderPrewetName`: Name of most recent type of prewet material spread, read
1453
+ # from the material spreader.
1454
+ # - `spreaderLiquidName`: Name of most recent type of liquid material spread, read
1455
+ # from the material spreader.
1456
+ # - `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the
1457
+ # material spreader. Note: this is separate from plow status defined via auxInput.
1458
+ # - `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled`
1459
+ # or `Unbuckled`. (Beta only)
1460
+ # @param request_options [Samsara::RequestOptions]
1461
+ # @return [Samsara::Types::VehicleStatsListResponse]
1462
+ # @example
1463
+ # api = Samsara::Client.new(
1464
+ # base_url: "https://api.example.com",
1465
+ # environment: Samsara::Environment::PRODUCTION_API,
1466
+ # token: "YOUR_AUTH_TOKEN"
1467
+ # )
1468
+ # api.vehicles.stats.history(start_time: "startTime", end_time: "endTime")
1469
+ def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, types: nil, decorations: nil, request_options: nil)
1470
+ Async do
1471
+ response = @request_client.conn.get do | req |
1472
+ unless request_options&.timeout_in_seconds.nil?
1473
+ req.options.timeout = request_options.timeout_in_seconds
1474
+ end
1475
+ unless request_options&.token.nil?
1476
+ req.headers["Authorization"] = request_options.token
1477
+ end
1478
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
1479
+ req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_ids, "types": types, "decorations": decorations }.compact
1480
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
1481
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
1482
+ end
1483
+ req.url "#{@request_client.get_url(request_options: request_options)}/fleet/vehicles/stats/history"
1484
+ end
1485
+ Samsara::Types::VehicleStatsListResponse.from_json(json_object: response.body)
1486
+ end
1487
+ end
1488
+ end
1489
+ end
1490
+ end