samsara-api 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

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 (343) hide show
  1. samsara/__init__.py +298 -38
  2. samsara/alerts/configurations/client.py +25 -11
  3. samsara/alerts/configurations/raw_client.py +47 -8
  4. samsara/alerts/incidents/client.py +21 -11
  5. samsara/alerts/incidents/raw_client.py +43 -9
  6. samsara/assets/client.py +21 -11
  7. samsara/assets/location_and_speed/client.py +21 -13
  8. samsara/assets/location_and_speed/raw_client.py +53 -9
  9. samsara/assets/raw_client.py +53 -8
  10. samsara/attributes/client.py +21 -13
  11. samsara/attributes/raw_client.py +41 -8
  12. samsara/cameras/media/client.py +2 -2
  13. samsara/cameras/media/raw_client.py +2 -2
  14. samsara/cameras/media/retrieval/client.py +2 -12
  15. samsara/cameras/media/types/media_list_request_trigger_reasons_item.py +8 -1
  16. samsara/carrier_proposed_assignments/client.py +21 -11
  17. samsara/carrier_proposed_assignments/raw_client.py +43 -8
  18. samsara/client.py +15 -6
  19. samsara/coaching/driver_coach_assignments/client.py +22 -12
  20. samsara/coaching/driver_coach_assignments/raw_client.py +45 -8
  21. samsara/coaching/sessions/client.py +21 -13
  22. samsara/coaching/sessions/raw_client.py +51 -9
  23. samsara/contacts/client.py +21 -11
  24. samsara/contacts/raw_client.py +39 -8
  25. samsara/core/client_wrapper.py +2 -2
  26. samsara/defect_types/client.py +21 -11
  27. samsara/defect_types/raw_client.py +41 -9
  28. samsara/defects/client.py +124 -9
  29. samsara/defects/raw_client.py +356 -6
  30. samsara/devices/client.py +21 -11
  31. samsara/devices/raw_client.py +45 -9
  32. samsara/document_types/client.py +21 -11
  33. samsara/document_types/raw_client.py +37 -9
  34. samsara/documents/client.py +21 -11
  35. samsara/documents/raw_client.py +45 -8
  36. samsara/driver_trailer_assignments/client.py +23 -13
  37. samsara/driver_trailer_assignments/raw_client.py +43 -8
  38. samsara/drivers/__init__.py +1 -3
  39. samsara/drivers/client.py +21 -21
  40. samsara/drivers/raw_client.py +51 -8
  41. samsara/dvirs/client.py +124 -9
  42. samsara/dvirs/raw_client.py +356 -6
  43. samsara/equipment/__init__.py +2 -2
  44. samsara/equipment/client.py +23 -21
  45. samsara/equipment/locations/client.py +62 -34
  46. samsara/equipment/locations/raw_client.py +132 -27
  47. samsara/equipment/raw_client.py +45 -18
  48. samsara/equipment/stats/__init__.py +2 -2
  49. samsara/equipment/stats/client.py +81 -53
  50. samsara/equipment/stats/raw_client.py +157 -46
  51. samsara/equipment/stats/types/__init__.py +2 -2
  52. samsara/equipment/stats/types/{stats_get_request_types_item.py → stats_list_request_types_item.py} +1 -1
  53. samsara/form_submissions/client.py +46 -54
  54. samsara/form_submissions/pdf_exports/client.py +14 -22
  55. samsara/form_submissions/pdf_exports/raw_client.py +10 -18
  56. samsara/form_submissions/raw_client.py +74 -47
  57. samsara/forms/client.py +138 -0
  58. samsara/{beta → forms}/raw_client.py +37 -62
  59. samsara/function.py +99 -0
  60. samsara/gateways/client.py +21 -11
  61. samsara/gateways/raw_client.py +39 -8
  62. samsara/hos/__init__.py +3 -0
  63. samsara/hos/client.py +218 -11
  64. samsara/hos/raw_client.py +485 -8
  65. samsara/hos/types/__init__.py +7 -0
  66. samsara/hos/types/hos_daily_logs_request_driver_activation_status.py +5 -0
  67. samsara/idling/__init__.py +7 -0
  68. samsara/idling/client.py +287 -0
  69. samsara/idling/raw_client.py +521 -0
  70. samsara/idling/types/__init__.py +7 -0
  71. samsara/idling/types/idling_list_request_pto_state.py +5 -0
  72. samsara/inputs/client.py +21 -11
  73. samsara/inputs/raw_client.py +51 -9
  74. samsara/issues/client.py +27 -29
  75. samsara/issues/raw_client.py +53 -26
  76. samsara/live_shares/client.py +21 -13
  77. samsara/live_shares/raw_client.py +43 -8
  78. samsara/maintenance/service_tasks/client.py +21 -11
  79. samsara/maintenance/service_tasks/raw_client.py +41 -8
  80. samsara/maintenance/work_orders/client.py +40 -22
  81. samsara/maintenance/work_orders/raw_client.py +84 -16
  82. samsara/readings/client.py +524 -0
  83. samsara/readings/raw_client.py +1214 -0
  84. samsara/reports/drivers/fuel_energy/client.py +6 -6
  85. samsara/reports/drivers/fuel_energy/raw_client.py +2 -2
  86. samsara/reports/ifta/__init__.py +4 -4
  87. samsara/reports/ifta/vehicle/__init__.py +2 -2
  88. samsara/reports/ifta/vehicle/client.py +21 -21
  89. samsara/reports/ifta/vehicle/raw_client.py +17 -17
  90. samsara/reports/ifta/vehicle/types/__init__.py +4 -4
  91. samsara/reports/ifta/vehicle/types/{vehicle_get_request_fuel_type.py → vehicle_list_request_fuel_type.py} +1 -1
  92. samsara/reports/ifta/vehicle/types/{vehicle_get_request_month.py → vehicle_list_request_month.py} +1 -1
  93. samsara/reports/ifta/vehicle/types/vehicle_list_request_quarter.py +5 -0
  94. samsara/reports/vehicles/__init__.py +2 -2
  95. samsara/reports/vehicles/fuel_energy/__init__.py +2 -2
  96. samsara/reports/vehicles/fuel_energy/client.py +11 -11
  97. samsara/reports/vehicles/fuel_energy/raw_client.py +7 -7
  98. samsara/reports/vehicles/fuel_energy/types/__init__.py +2 -2
  99. samsara/reports/vehicles/fuel_energy/types/fuel_energy_list_request_energy_type.py +5 -0
  100. samsara/reports/vehicles/idling/client.py +27 -15
  101. samsara/reports/vehicles/idling/raw_client.py +59 -11
  102. samsara/routes/client.py +21 -11
  103. samsara/routes/raw_client.py +43 -8
  104. samsara/safety_events/audit_logs/client.py +21 -13
  105. samsara/safety_events/audit_logs/raw_client.py +39 -9
  106. samsara/safety_events/client.py +21 -11
  107. samsara/safety_events/raw_client.py +47 -9
  108. samsara/speeding_intervals/client.py +25 -17
  109. samsara/speeding_intervals/raw_client.py +55 -13
  110. samsara/tachograph/__init__.py +7 -0
  111. samsara/tachograph/client.py +44 -0
  112. samsara/{drivers/tachograph_files → tachograph/driver}/client.py +162 -15
  113. samsara/{drivers/tachograph_files → tachograph/driver}/raw_client.py +153 -4
  114. samsara/tachograph/raw_client.py +13 -0
  115. samsara/{vehicles/tachograph_files → tachograph/vehicles}/client.py +15 -15
  116. samsara/{vehicles/tachograph_files → tachograph/vehicles}/raw_client.py +4 -4
  117. samsara/tags/client.py +21 -11
  118. samsara/tags/raw_client.py +39 -8
  119. samsara/trailers/client.py +21 -11
  120. samsara/trailers/raw_client.py +43 -8
  121. samsara/training_courses/client.py +21 -11
  122. samsara/training_courses/raw_client.py +43 -9
  123. samsara/trips/client.py +21 -11
  124. samsara/trips/raw_client.py +49 -9
  125. samsara/types/__init__.py +406 -50
  126. samsara/types/advanced_idling_get_idling_events_bad_gateway_error_response_body.py +33 -0
  127. samsara/types/advanced_idling_get_idling_events_gateway_timeout_error_response_body.py +33 -0
  128. samsara/types/{hos_daily_logs_update_shipping_docs_internal_server_error_response_body.py → advanced_idling_get_idling_events_internal_server_error_response_body.py} +1 -1
  129. samsara/types/advanced_idling_get_idling_events_method_not_allowed_error_response_body.py +33 -0
  130. samsara/types/{hos_daily_logs_update_shipping_docs_not_found_error_response_body.py → advanced_idling_get_idling_events_not_found_error_response_body.py} +1 -1
  131. samsara/types/{hos_daily_logs_update_shipping_docs_not_implemented_error_response_body.py → advanced_idling_get_idling_events_not_implemented_error_response_body.py} +1 -1
  132. samsara/types/advanced_idling_get_idling_events_response_body.py +26 -0
  133. samsara/types/{hos_daily_logs_update_shipping_docs_service_unavailable_error_response_body.py → advanced_idling_get_idling_events_service_unavailable_error_response_body.py} +1 -1
  134. samsara/types/{hos_daily_logs_update_shipping_docs_gateway_timeout_error_response_body.py → advanced_idling_get_idling_events_too_many_requests_error_response_body.py} +2 -2
  135. samsara/types/advanced_idling_get_idling_events_unauthorized_error_response_body.py +33 -0
  136. samsara/types/alert_object_asset_response_body.py +63 -0
  137. samsara/types/{assets_create_asset_response_body_type.py → alert_object_asset_response_body_type.py} +1 -1
  138. samsara/types/assets_create_asset_response_body.py +2 -87
  139. samsara/types/assets_update_asset_response_body.py +2 -87
  140. samsara/types/continuous_reading_alert_threshold_response_body.py +49 -0
  141. samsara/types/continuous_reading_alert_threshold_response_body_operation.py +7 -0
  142. samsara/types/continuous_reading_alert_threshold_response_body_unit.py +62 -0
  143. samsara/types/device_response_response_body.py +1 -1
  144. samsara/types/device_response_response_body_model.py +1 -0
  145. samsara/types/dvir_defect_get_defect_bad_gateway_error_response_body.py +33 -0
  146. samsara/types/dvir_defect_get_defect_gateway_timeout_error_response_body.py +33 -0
  147. samsara/types/dvir_defect_get_defect_internal_server_error_response_body.py +33 -0
  148. samsara/types/dvir_defect_get_defect_method_not_allowed_error_response_body.py +33 -0
  149. samsara/types/dvir_defect_get_defect_not_found_error_response_body.py +33 -0
  150. samsara/types/dvir_defect_get_defect_not_implemented_error_response_body.py +33 -0
  151. samsara/types/dvir_defect_get_defect_response_body.py +91 -0
  152. samsara/types/dvir_defect_get_defect_service_unavailable_error_response_body.py +33 -0
  153. samsara/types/dvir_defect_get_defect_too_many_requests_error_response_body.py +33 -0
  154. samsara/types/dvir_defect_get_defect_unauthorized_error_response_body.py +33 -0
  155. samsara/types/dvir_get_dvir_bad_gateway_error_response_body.py +33 -0
  156. samsara/types/dvir_get_dvir_gateway_timeout_error_response_body.py +33 -0
  157. samsara/types/dvir_get_dvir_internal_server_error_response_body.py +33 -0
  158. samsara/types/dvir_get_dvir_method_not_allowed_error_response_body.py +33 -0
  159. samsara/types/dvir_get_dvir_not_found_error_response_body.py +33 -0
  160. samsara/types/dvir_get_dvir_not_implemented_error_response_body.py +33 -0
  161. samsara/types/dvir_get_dvir_response_body.py +99 -0
  162. samsara/types/dvir_get_dvir_response_body_safety_status.py +5 -0
  163. samsara/types/dvir_get_dvir_response_body_type.py +5 -0
  164. samsara/types/dvir_get_dvir_service_unavailable_error_response_body.py +33 -0
  165. samsara/types/dvir_get_dvir_too_many_requests_error_response_body.py +33 -0
  166. samsara/types/dvir_get_dvir_unauthorized_error_response_body.py +33 -0
  167. samsara/types/enum_reading_alert_threshold_response_body.py +31 -0
  168. samsara/types/enum_value_response_body.py +31 -0
  169. samsara/types/equipment_gateway_engine_seconds.py +1 -1
  170. samsara/types/equipment_gateway_j_1939_engine_seconds.py +1 -1
  171. samsara/types/equipment_obd_engine_seconds.py +1 -1
  172. samsara/types/event_location_response_body.py +31 -0
  173. samsara/types/form_submission_request_field_input_object_request_body.py +7 -1
  174. samsara/types/form_submission_request_field_input_object_request_body_type.py +3 -1
  175. samsara/types/{hos_daily_logs_update_shipping_docs_response_body.py → form_submission_request_geofence_object_request_body.py} +9 -3
  176. samsara/types/form_submission_request_geofence_value_object_request_body.py +24 -0
  177. samsara/types/form_submission_response_object_response_body.py +8 -0
  178. samsara/types/{form_template_reference_object_request_body.py → form_template_request_object_request_body.py} +6 -4
  179. samsara/types/form_template_response_object_response_body.py +74 -0
  180. samsara/types/form_template_section_object_response_body.py +47 -0
  181. samsara/types/form_templates_get_form_templates_bad_gateway_error_response_body.py +33 -0
  182. samsara/types/form_templates_get_form_templates_gateway_timeout_error_response_body.py +33 -0
  183. samsara/types/form_templates_get_form_templates_internal_server_error_response_body.py +33 -0
  184. samsara/types/form_templates_get_form_templates_method_not_allowed_error_response_body.py +33 -0
  185. samsara/types/form_templates_get_form_templates_not_found_error_response_body.py +33 -0
  186. samsara/types/form_templates_get_form_templates_not_implemented_error_response_body.py +33 -0
  187. samsara/types/form_templates_get_form_templates_response_body.py +26 -0
  188. samsara/types/form_templates_get_form_templates_service_unavailable_error_response_body.py +33 -0
  189. samsara/types/form_templates_get_form_templates_too_many_requests_error_response_body.py +33 -0
  190. samsara/types/form_templates_get_form_templates_unauthorized_error_response_body.py +33 -0
  191. samsara/types/forms_action_object_response_body.py +43 -0
  192. samsara/types/forms_action_object_response_body_type.py +7 -0
  193. samsara/types/forms_approval_config_object_response_body.py +32 -0
  194. samsara/types/forms_asset_object_response_body.py +8 -1
  195. samsara/types/forms_check_boxes_value_object_response_body.py +7 -0
  196. samsara/types/forms_condition_object_response_body.py +36 -0
  197. samsara/types/forms_condition_object_response_body_type.py +7 -0
  198. samsara/types/forms_conditional_action_object_response_body.py +30 -0
  199. samsara/types/forms_field_definition_object_response_body.py +143 -0
  200. samsara/types/forms_field_definition_object_response_body_allowed_asset_types_item.py +7 -0
  201. samsara/types/forms_field_definition_object_response_body_allowed_date_time_value_type.py +7 -0
  202. samsara/types/forms_field_definition_object_response_body_type.py +22 -0
  203. samsara/types/forms_field_input_object_response_body.py +7 -4
  204. samsara/types/forms_field_input_object_response_body_type.py +20 -0
  205. samsara/types/forms_geofence_object_response_body.py +53 -0
  206. samsara/types/forms_geofence_object_response_body_entry_type.py +5 -0
  207. samsara/types/forms_geofence_value_object_response_body.py +24 -0
  208. samsara/types/forms_multiple_choice_value_object_response_body.py +8 -1
  209. samsara/types/forms_product_submission_approval_details_object_response_body.py +26 -0
  210. samsara/types/forms_select_option_object_response_body.py +47 -0
  211. samsara/types/forms_single_approval_config_object_response_body.py +33 -0
  212. samsara/types/forms_table_cell_object_response_body.py +3 -4
  213. samsara/types/forms_table_cell_object_response_body_type.py +8 -0
  214. samsara/types/forms_table_column_object_response_body.py +3 -4
  215. samsara/types/forms_table_column_object_response_body_type.py +8 -0
  216. samsara/types/forms_table_field_definition_object_response_body.py +91 -0
  217. samsara/types/forms_table_field_definition_object_response_body_allowed_date_time_value_type.py +7 -0
  218. samsara/types/forms_table_field_definition_object_response_body_type.py +8 -0
  219. samsara/types/fuel_cost_object_response_body.py +32 -0
  220. samsara/types/fuel_cost_object_response_body_currency.py +5 -0
  221. samsara/types/fuel_volume_response_body.py +28 -0
  222. samsara/types/fuel_volume_response_body_unit.py +5 -0
  223. samsara/types/gaseous_fuel_cost_object_response_body.py +32 -0
  224. samsara/types/gaseous_fuel_cost_object_response_body_currency.py +7 -0
  225. samsara/types/gateway_details_response_response_body.py +14 -0
  226. samsara/types/harsh_event_trigger_details_object_request_body_types_item.py +1 -0
  227. samsara/types/harsh_event_trigger_details_object_response_body_types_item.py +1 -0
  228. samsara/types/idling_event_object_response_body.py +101 -0
  229. samsara/types/idling_event_object_response_body_address_type.py +17 -0
  230. samsara/types/inline_response_2005.py +24 -0
  231. samsara/types/inline_response_2006.py +24 -0
  232. samsara/types/reading_definition_response_body.py +59 -0
  233. samsara/types/reading_history_response_body.py +47 -0
  234. samsara/types/reading_snapshot_response_body.py +52 -0
  235. samsara/types/reading_trigger_continuous_value_object_request_body.py +51 -0
  236. samsara/types/reading_trigger_continuous_value_object_request_body_operation.py +7 -0
  237. samsara/types/reading_trigger_continuous_value_object_request_body_unit.py +62 -0
  238. samsara/types/reading_trigger_continuous_value_object_response_body.py +51 -0
  239. samsara/types/reading_trigger_continuous_value_object_response_body_operation.py +7 -0
  240. samsara/types/reading_trigger_continuous_value_object_response_body_unit.py +62 -0
  241. samsara/types/reading_trigger_details_object_request_body.py +48 -0
  242. samsara/types/reading_trigger_details_object_response_body.py +48 -0
  243. samsara/types/reading_trigger_details_response_body.py +38 -0
  244. samsara/types/reading_trigger_enum_value_object_request_body.py +31 -0
  245. samsara/types/reading_trigger_enum_value_object_response_body.py +31 -0
  246. samsara/types/reading_type_response_body.py +34 -0
  247. samsara/types/reading_type_response_body_data_type.py +5 -0
  248. samsara/types/readings_get_readings_history_bad_gateway_error_response_body.py +33 -0
  249. samsara/types/{hos_daily_logs_update_shipping_docs_bad_gateway_error_response_body.py → readings_get_readings_history_gateway_timeout_error_response_body.py} +2 -2
  250. samsara/types/readings_get_readings_history_internal_server_error_response_body.py +33 -0
  251. samsara/types/readings_get_readings_history_method_not_allowed_error_response_body.py +33 -0
  252. samsara/types/readings_get_readings_history_not_found_error_response_body.py +33 -0
  253. samsara/types/readings_get_readings_history_not_implemented_error_response_body.py +33 -0
  254. samsara/types/readings_get_readings_history_response_body.py +26 -0
  255. samsara/types/readings_get_readings_history_service_unavailable_error_response_body.py +33 -0
  256. samsara/types/readings_get_readings_history_too_many_requests_error_response_body.py +33 -0
  257. samsara/types/readings_get_readings_history_unauthorized_error_response_body.py +33 -0
  258. samsara/types/readings_get_readings_snapshot_bad_gateway_error_response_body.py +33 -0
  259. samsara/types/readings_get_readings_snapshot_gateway_timeout_error_response_body.py +33 -0
  260. samsara/types/readings_get_readings_snapshot_internal_server_error_response_body.py +33 -0
  261. samsara/types/readings_get_readings_snapshot_method_not_allowed_error_response_body.py +33 -0
  262. samsara/types/readings_get_readings_snapshot_not_found_error_response_body.py +33 -0
  263. samsara/types/readings_get_readings_snapshot_not_implemented_error_response_body.py +33 -0
  264. samsara/types/readings_get_readings_snapshot_response_body.py +26 -0
  265. samsara/types/readings_get_readings_snapshot_service_unavailable_error_response_body.py +33 -0
  266. samsara/types/{hos_daily_logs_update_shipping_docs_unauthorized_error_response_body.py → readings_get_readings_snapshot_too_many_requests_error_response_body.py} +2 -2
  267. samsara/types/readings_get_readings_snapshot_unauthorized_error_response_body.py +33 -0
  268. samsara/types/readings_list_readings_definitions_bad_gateway_error_response_body.py +33 -0
  269. samsara/types/{hos_daily_logs_update_shipping_docs_too_many_requests_error_response_body.py → readings_list_readings_definitions_gateway_timeout_error_response_body.py} +2 -2
  270. samsara/types/readings_list_readings_definitions_internal_server_error_response_body.py +33 -0
  271. samsara/types/readings_list_readings_definitions_method_not_allowed_error_response_body.py +33 -0
  272. samsara/types/readings_list_readings_definitions_not_found_error_response_body.py +33 -0
  273. samsara/types/readings_list_readings_definitions_not_implemented_error_response_body.py +33 -0
  274. samsara/types/readings_list_readings_definitions_response_body.py +26 -0
  275. samsara/types/readings_list_readings_definitions_service_unavailable_error_response_body.py +33 -0
  276. samsara/types/{hos_daily_logs_update_shipping_docs_method_not_allowed_error_response_body.py → readings_list_readings_definitions_too_many_requests_error_response_body.py} +2 -2
  277. samsara/types/readings_list_readings_definitions_unauthorized_error_response_body.py +33 -0
  278. samsara/types/safety_score_configuration_settings_object_response_body.py +7 -0
  279. samsara/types/single_approval_requirements_object_response_body.py +28 -0
  280. samsara/types/sudden_fuel_level_drop_response_body.py +33 -0
  281. samsara/types/sudden_fuel_level_rise_response_body.py +33 -0
  282. samsara/types/trigger_params_object_request_body.py +2 -0
  283. samsara/types/trigger_params_object_response_body.py +2 -0
  284. samsara/types/unit_response_body.py +39 -0
  285. samsara/types/unit_response_body_base_unit.py +62 -0
  286. samsara/types/unit_response_body_measurement_type.py +28 -0
  287. samsara/types/uploaded_media_object_response_body.py +1 -1
  288. samsara/types/uploaded_media_object_response_body_trigger_reason.py +8 -1
  289. samsara/types/v_1_message.py +29 -0
  290. samsara/types/v_1_message_response.py +41 -0
  291. samsara/types/v_1_message_sender.py +27 -0
  292. samsara/types/v_1_messages.py +7 -0
  293. samsara/types/v_1_messages_response.py +7 -0
  294. samsara/types/webhook_response_response_body_event_types_item.py +1 -0
  295. samsara/types/webhooks_get_webhook_response_body_event_types_item.py +1 -0
  296. samsara/types/webhooks_patch_webhook_response_body_event_types_item.py +1 -0
  297. samsara/types/webhooks_post_webhooks_response_body_event_types_item.py +1 -0
  298. samsara/types/workflow_geofence_event_response_object_response_body.py +6 -0
  299. samsara/types/workflow_incident_details_object_response_body.py +2 -0
  300. samsara/types/workflow_trigger_object_request_body.py +1 -0
  301. samsara/types/workflow_trigger_object_response_body.py +1 -0
  302. samsara/user_roles/client.py +21 -11
  303. samsara/user_roles/raw_client.py +39 -9
  304. samsara/users/client.py +21 -11
  305. samsara/users/raw_client.py +39 -8
  306. samsara/v_1_messages/__init__.py +4 -0
  307. samsara/v_1_messages/client.py +258 -0
  308. samsara/v_1_messages/raw_client.py +273 -0
  309. samsara/vehicles/__init__.py +1 -2
  310. samsara/vehicles/client.py +31 -16
  311. samsara/vehicles/immobilizer/client.py +21 -13
  312. samsara/vehicles/immobilizer/raw_client.py +43 -9
  313. samsara/vehicles/locations/client.py +60 -32
  314. samsara/vehicles/locations/raw_client.py +132 -25
  315. samsara/vehicles/raw_client.py +61 -8
  316. samsara/vehicles/stats/client.py +66 -38
  317. samsara/vehicles/stats/raw_client.py +148 -31
  318. samsara/webhooks/client.py +21 -11
  319. samsara/webhooks/raw_client.py +41 -8
  320. samsara/webhooks/types/webhooks_post_webhooks_request_body_event_types_item.py +1 -0
  321. samsara_api-0.0.2.dist-info/METADATA +29 -0
  322. {samsara_api-0.0.1.dist-info → samsara_api-0.0.2.dist-info}/RECORD +328 -193
  323. samsara/beta/client.py +0 -161
  324. samsara/drivers/tachograph_activity/client.py +0 -186
  325. samsara/drivers/tachograph_activity/raw_client.py +0 -169
  326. samsara/hours_of_service/__init__.py +0 -7
  327. samsara/hours_of_service/client.py +0 -229
  328. samsara/hours_of_service/raw_client.py +0 -425
  329. samsara/hours_of_service/types/__init__.py +0 -9
  330. samsara/hours_of_service/types/hours_of_service_get_daily_logs_request_driver_activation_status.py +0 -7
  331. samsara/reports/ifta/vehicle/types/vehicle_get_request_quarter.py +0 -5
  332. samsara/reports/vehicles/fuel_energy/types/fuel_energy_get_request_energy_type.py +0 -5
  333. samsara/types/assets_create_asset_response_body_regulation_mode.py +0 -7
  334. samsara/types/assets_update_asset_response_body_regulation_mode.py +0 -7
  335. samsara/types/assets_update_asset_response_body_type.py +0 -7
  336. samsara/types/patch_shipping_docs_response_body_response_body.py +0 -93
  337. samsara_api-0.0.1.dist-info/METADATA +0 -214
  338. /samsara/{beta → forms}/__init__.py +0 -0
  339. /samsara/{drivers/tachograph_activity → readings}/__init__.py +0 -0
  340. /samsara/{drivers/tachograph_files → tachograph/driver}/__init__.py +0 -0
  341. /samsara/{vehicles/tachograph_files → tachograph/vehicles}/__init__.py +0 -0
  342. {samsara_api-0.0.1.dist-info → samsara_api-0.0.2.dist-info}/LICENSE +0 -0
  343. {samsara_api-0.0.1.dist-info → samsara_api-0.0.2.dist-info}/WHEEL +0 -0
@@ -0,0 +1,24 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .forms_geofence_object_response_body import FormsGeofenceObjectResponseBody
8
+
9
+
10
+ class FormsGeofenceValueObjectResponseBody(UniversalBaseModel):
11
+ """
12
+ The value of a geofence form input field.
13
+ """
14
+
15
+ geofence: FormsGeofenceObjectResponseBody
16
+
17
+ if IS_PYDANTIC_V2:
18
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
19
+ else:
20
+
21
+ class Config:
22
+ frozen = True
23
+ smart_union = True
24
+ extra = pydantic.Extra.allow
@@ -3,7 +3,9 @@
3
3
  import typing
4
4
 
5
5
  import pydantic
6
+ import typing_extensions
6
7
  from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
8
+ from ..core.serialization import FieldMetadata
7
9
 
8
10
 
9
11
  class FormsMultipleChoiceValueObjectResponseBody(UniversalBaseModel):
@@ -13,7 +15,12 @@ class FormsMultipleChoiceValueObjectResponseBody(UniversalBaseModel):
13
15
 
14
16
  value: str = pydantic.Field()
15
17
  """
16
- Selected choice.
18
+ Selected option.
19
+ """
20
+
21
+ value_id: typing_extensions.Annotated[str, FieldMetadata(alias="valueId")] = pydantic.Field()
22
+ """
23
+ ID of the selected option.
17
24
  """
18
25
 
19
26
  if IS_PYDANTIC_V2:
@@ -0,0 +1,26 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+
8
+
9
+ class FormsProductSubmissionApprovalDetailsObjectResponseBody(UniversalBaseModel):
10
+ """
11
+ The value of the approval details for a forms product submission.
12
+ """
13
+
14
+ comment: str = pydantic.Field()
15
+ """
16
+ Comment from the approver when requesting changes or approving the submission.
17
+ """
18
+
19
+ if IS_PYDANTIC_V2:
20
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
21
+ else:
22
+
23
+ class Config:
24
+ frozen = True
25
+ smart_union = True
26
+ extra = pydantic.Extra.allow
@@ -0,0 +1,47 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ import typing_extensions
7
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
8
+ from ..core.serialization import FieldMetadata
9
+
10
+
11
+ class FormsSelectOptionObjectResponseBody(UniversalBaseModel):
12
+ """
13
+ Multiple choice or checkbox value option object.
14
+ """
15
+
16
+ id: str = pydantic.Field()
17
+ """
18
+ Identifier of the option.
19
+ """
20
+
21
+ ignore_question_from_score_if_selected: typing_extensions.Annotated[
22
+ typing.Optional[bool], FieldMetadata(alias="ignoreQuestionFromScoreIfSelected")
23
+ ] = pydantic.Field(default=None)
24
+ """
25
+ Indicates whether the question should be ignored from the total score if this option is selected. Returns true if a score weight was not given to this option. Only present when the select form field has scoring.
26
+ """
27
+
28
+ label: str = pydantic.Field()
29
+ """
30
+ Label of the option.
31
+ """
32
+
33
+ option_score_weight: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="optionScoreWeight")] = (
34
+ pydantic.Field(default=None)
35
+ )
36
+ """
37
+ Score weight of the option, indicates number of score points received if this option is selected. Only present if the select form field has scoring.
38
+ """
39
+
40
+ if IS_PYDANTIC_V2:
41
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
42
+ else:
43
+
44
+ class Config:
45
+ frozen = True
46
+ smart_union = True
47
+ extra = pydantic.Extra.allow
@@ -0,0 +1,33 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ import typing_extensions
7
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
8
+ from ..core.serialization import FieldMetadata
9
+ from .single_approval_requirements_object_response_body import SingleApprovalRequirementsObjectResponseBody
10
+
11
+
12
+ class FormsSingleApprovalConfigObjectResponseBody(UniversalBaseModel):
13
+ """
14
+ Single approval configuration object.
15
+ """
16
+
17
+ allow_manual_approver_selection: typing_extensions.Annotated[
18
+ bool, FieldMetadata(alias="allowManualApproverSelection")
19
+ ] = pydantic.Field()
20
+ """
21
+ Indicates whether approver can be manually selected. True by default.
22
+ """
23
+
24
+ requirements: SingleApprovalRequirementsObjectResponseBody
25
+
26
+ if IS_PYDANTIC_V2:
27
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
28
+ else:
29
+
30
+ class Config:
31
+ frozen = True
32
+ smart_union = True
33
+ extra = pydantic.Extra.allow
@@ -13,6 +13,7 @@ from .forms_multiple_choice_value_object_response_body import FormsMultipleChoic
13
13
  from .forms_number_value_object_response_body import FormsNumberValueObjectResponseBody
14
14
  from .forms_person_value_object_response_body import FormsPersonValueObjectResponseBody
15
15
  from .forms_signature_value_object_response_body import FormsSignatureValueObjectResponseBody
16
+ from .forms_table_cell_object_response_body_type import FormsTableCellObjectResponseBodyType
16
17
  from .forms_text_value_object_response_body import FormsTextValueObjectResponseBody
17
18
 
18
19
 
@@ -50,11 +51,9 @@ class FormsTableCellObjectResponseBody(UniversalBaseModel):
50
51
  text_value: typing_extensions.Annotated[
51
52
  typing.Optional[FormsTextValueObjectResponseBody], FieldMetadata(alias="textValue")
52
53
  ] = None
53
- type: typing.Literal["number, text, multiple_choice, check_boxes, datetime, signature, media, person"] = (
54
- pydantic.Field(default="number, text, multiple_choice, check_boxes, datetime, signature, media, person")
55
- )
54
+ type: FormsTableCellObjectResponseBodyType = pydantic.Field()
56
55
  """
57
- Type of the cell field. Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, person`
56
+ Type of the cell field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `datetime`, `signature`, `media`, `person`
58
57
  """
59
58
 
60
59
  if IS_PYDANTIC_V2:
@@ -0,0 +1,8 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FormsTableCellObjectResponseBodyType = typing.Union[
6
+ typing.Literal["number", "text", "multiple_choice", "check_boxes", "datetime", "signature", "media", "person"],
7
+ typing.Any,
8
+ ]
@@ -4,6 +4,7 @@ import typing
4
4
 
5
5
  import pydantic
6
6
  from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .forms_table_column_object_response_body_type import FormsTableColumnObjectResponseBodyType
7
8
 
8
9
 
9
10
  class FormsTableColumnObjectResponseBody(UniversalBaseModel):
@@ -21,11 +22,9 @@ class FormsTableColumnObjectResponseBody(UniversalBaseModel):
21
22
  Label of the column.
22
23
  """
23
24
 
24
- type: typing.Literal["text, number, datetime, check_boxes, multiple_choice, signature, media, person"] = (
25
- pydantic.Field(default="text, number, datetime, check_boxes, multiple_choice, signature, media, person")
26
- )
25
+ type: FormsTableColumnObjectResponseBodyType = pydantic.Field()
27
26
  """
28
- Type of the column field. Valid values: `text, number, datetime, check_boxes, multiple_choice, signature, media, person`
27
+ Type of the column field. Valid values: `text`, `number`, `datetime`, `check_boxes`, `multiple_choice`, `signature`, `media`, `person`
29
28
  """
30
29
 
31
30
  if IS_PYDANTIC_V2:
@@ -0,0 +1,8 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FormsTableColumnObjectResponseBodyType = typing.Union[
6
+ typing.Literal["text", "number", "datetime", "check_boxes", "multiple_choice", "signature", "media", "person"],
7
+ typing.Any,
8
+ ]
@@ -0,0 +1,91 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ import typing_extensions
7
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
8
+ from ..core.serialization import FieldMetadata
9
+ from .forms_select_option_object_response_body import FormsSelectOptionObjectResponseBody
10
+ from .forms_table_field_definition_object_response_body_allowed_date_time_value_type import (
11
+ FormsTableFieldDefinitionObjectResponseBodyAllowedDateTimeValueType,
12
+ )
13
+ from .forms_table_field_definition_object_response_body_type import FormsTableFieldDefinitionObjectResponseBodyType
14
+
15
+
16
+ class FormsTableFieldDefinitionObjectResponseBody(UniversalBaseModel):
17
+ """
18
+ Forms table field definition object.
19
+ """
20
+
21
+ allow_manual_entry: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="allowManualEntry")] = (
22
+ pydantic.Field(default=None)
23
+ )
24
+ """
25
+ Indicates whether the field allows manual entry of a person. Only present for person fields.
26
+ """
27
+
28
+ allowed_date_time_value_type: typing_extensions.Annotated[
29
+ typing.Optional[FormsTableFieldDefinitionObjectResponseBodyAllowedDateTimeValueType],
30
+ FieldMetadata(alias="allowedDateTimeValueType"),
31
+ ] = pydantic.Field(default=None)
32
+ """
33
+ Type of date/time entry allowed for this question. Only present for datetime fields. Valid values: `datetime`, `date`, `time`
34
+ """
35
+
36
+ filter_by_role_ids: typing_extensions.Annotated[
37
+ typing.Optional[typing.List[str]], FieldMetadata(alias="filterByRoleIds")
38
+ ] = pydantic.Field(default=None)
39
+ """
40
+ List of role IDs to filter org users by, representing which roles are selectable people for this field. Only present for person fields.
41
+ """
42
+
43
+ id: str = pydantic.Field()
44
+ """
45
+ Identifier of the field.
46
+ """
47
+
48
+ include_drivers: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="includeDrivers")] = (
49
+ pydantic.Field(default=None)
50
+ )
51
+ """
52
+ Indicates whether the field includes drivers as selectable people. Only present for person fields.
53
+ """
54
+
55
+ include_users: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="includeUsers")] = (
56
+ pydantic.Field(default=None)
57
+ )
58
+ """
59
+ Indicates whether the field includes users as selectable people. Only present for person fields.
60
+ """
61
+
62
+ label: str = pydantic.Field()
63
+ """
64
+ Label of the field.
65
+ """
66
+
67
+ num_decimal_places: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="numDecimalPlaces")] = (
68
+ pydantic.Field(default=None)
69
+ )
70
+ """
71
+ Number of decimal places allowed. Only present for number fields.
72
+ """
73
+
74
+ options: typing.Optional[typing.List[FormsSelectOptionObjectResponseBody]] = pydantic.Field(default=None)
75
+ """
76
+ List of select options for check boxes or multiple choice fields.
77
+ """
78
+
79
+ type: FormsTableFieldDefinitionObjectResponseBodyType = pydantic.Field()
80
+ """
81
+ Type of the field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `media`, `datetime`, `signature`, `person`
82
+ """
83
+
84
+ if IS_PYDANTIC_V2:
85
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
86
+ else:
87
+
88
+ class Config:
89
+ frozen = True
90
+ smart_union = True
91
+ extra = pydantic.Extra.allow
@@ -0,0 +1,7 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FormsTableFieldDefinitionObjectResponseBodyAllowedDateTimeValueType = typing.Union[
6
+ typing.Literal["datetime", "date", "time"], typing.Any
7
+ ]
@@ -0,0 +1,8 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FormsTableFieldDefinitionObjectResponseBodyType = typing.Union[
6
+ typing.Literal["number", "text", "multiple_choice", "check_boxes", "media", "datetime", "signature", "person"],
7
+ typing.Any,
8
+ ]
@@ -0,0 +1,32 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .fuel_cost_object_response_body_currency import FuelCostObjectResponseBodyCurrency
8
+
9
+
10
+ class FuelCostObjectResponseBody(UniversalBaseModel):
11
+ """
12
+ The cost incurred based on the fuel consumed during the idling event.
13
+ """
14
+
15
+ amount: str = pydantic.Field()
16
+ """
17
+ The money amount.
18
+ """
19
+
20
+ currency: FuelCostObjectResponseBodyCurrency = pydantic.Field()
21
+ """
22
+ The currency of money. This is a 3-letter ISO 4217 currency code. Valid values: `usd`, `gbp`, `cad`, `eur`, `chf`, `mxn`
23
+ """
24
+
25
+ if IS_PYDANTIC_V2:
26
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
27
+ else:
28
+
29
+ class Config:
30
+ frozen = True
31
+ smart_union = True
32
+ extra = pydantic.Extra.allow
@@ -0,0 +1,5 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FuelCostObjectResponseBodyCurrency = typing.Union[typing.Literal["usd", "gbp", "cad", "eur", "chf", "mxn"], typing.Any]
@@ -0,0 +1,28 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .fuel_volume_response_body_unit import FuelVolumeResponseBodyUnit
8
+
9
+
10
+ class FuelVolumeResponseBody(UniversalBaseModel):
11
+ unit: FuelVolumeResponseBodyUnit = pydantic.Field()
12
+ """
13
+ Units in which volume is being presented. Valid values: `GALLONS`, `LITERS`
14
+ """
15
+
16
+ value: float = pydantic.Field()
17
+ """
18
+ The volume of the measured fuel.
19
+ """
20
+
21
+ if IS_PYDANTIC_V2:
22
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
23
+ else:
24
+
25
+ class Config:
26
+ frozen = True
27
+ smart_union = True
28
+ extra = pydantic.Extra.allow
@@ -0,0 +1,5 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ FuelVolumeResponseBodyUnit = typing.Union[typing.Literal["GALLONS", "LITERS"], typing.Any]
@@ -0,0 +1,32 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .gaseous_fuel_cost_object_response_body_currency import GaseousFuelCostObjectResponseBodyCurrency
8
+
9
+
10
+ class GaseousFuelCostObjectResponseBody(UniversalBaseModel):
11
+ """
12
+ The cost incurred based on the gaseous fuel consumed during the idling event.
13
+ """
14
+
15
+ amount: str = pydantic.Field()
16
+ """
17
+ The money amount.
18
+ """
19
+
20
+ currency: GaseousFuelCostObjectResponseBodyCurrency = pydantic.Field()
21
+ """
22
+ The currency of money. This is a 3-letter ISO 4217 currency code. Valid values: `usd`, `gbp`, `cad`, `eur`, `chf`, `mxn`
23
+ """
24
+
25
+ if IS_PYDANTIC_V2:
26
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
27
+ else:
28
+
29
+ class Config:
30
+ frozen = True
31
+ smart_union = True
32
+ extra = pydantic.Extra.allow
@@ -0,0 +1,7 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ GaseousFuelCostObjectResponseBodyCurrency = typing.Union[
6
+ typing.Literal["usd", "gbp", "cad", "eur", "chf", "mxn"], typing.Any
7
+ ]
@@ -29,6 +29,20 @@ class GatewayDetailsResponseResponseBody(UniversalBaseModel):
29
29
  The gateway's battery state. Valid values: `low`, `ok`, `unknown`
30
30
  """
31
31
 
32
+ gateway_battery_temp: typing_extensions.Annotated[
33
+ typing.Optional[float], FieldMetadata(alias="gatewayBatteryTemp")
34
+ ] = pydantic.Field(default=None)
35
+ """
36
+ The battery temperature of the gateway, in degrees Celsius.
37
+ """
38
+
39
+ gateway_battery_volts: typing_extensions.Annotated[
40
+ typing.Optional[float], FieldMetadata(alias="gatewayBatteryVolts")
41
+ ] = pydantic.Field(default=None)
42
+ """
43
+ The battery voltage of the gateway, in volts.
44
+ """
45
+
32
46
  last_check_in_time: typing_extensions.Annotated[
33
47
  typing.Optional[dt.datetime], FieldMetadata(alias="lastCheckInTime")
34
48
  ] = pydantic.Field(default=None)
@@ -37,6 +37,7 @@ HarshEventTriggerDetailsObjectRequestBodyTypesItem = typing.Union[
37
37
  "haTailgating",
38
38
  "haTileRollingRailroadCrossing",
39
39
  "haTileRollingStopSign",
40
+ "haUnsafeParking",
40
41
  "haVulnerableRoadUserCollisionWarning",
41
42
  "haYawControlBrakeControlActivated",
42
43
  "haYawControlEngineControlActivated",
@@ -37,6 +37,7 @@ HarshEventTriggerDetailsObjectResponseBodyTypesItem = typing.Union[
37
37
  "haTailgating",
38
38
  "haTileRollingRailroadCrossing",
39
39
  "haTileRollingStopSign",
40
+ "haUnsafeParking",
40
41
  "haVulnerableRoadUserCollisionWarning",
41
42
  "haYawControlBrakeControlActivated",
42
43
  "haYawControlEngineControlActivated",
@@ -0,0 +1,101 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ import typing_extensions
7
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
8
+ from ..core.serialization import FieldMetadata
9
+ from .fuel_cost_object_response_body import FuelCostObjectResponseBody
10
+ from .gaseous_fuel_cost_object_response_body import GaseousFuelCostObjectResponseBody
11
+ from .idling_event_object_response_body_address_type import IdlingEventObjectResponseBodyAddressType
12
+
13
+
14
+ class IdlingEventObjectResponseBody(UniversalBaseModel):
15
+ """
16
+ An idling event object.
17
+ """
18
+
19
+ address_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="addressId")] = pydantic.Field(
20
+ default=None
21
+ )
22
+ """
23
+ The ID of the geofence address of the idling location, if applicable. It will be the address at the time of idling.
24
+ """
25
+
26
+ address_type: typing_extensions.Annotated[
27
+ typing.Optional[IdlingEventObjectResponseBodyAddressType], FieldMetadata(alias="addressType")
28
+ ] = pydantic.Field(default=None)
29
+ """
30
+ The type of the geofence address of the idling location, if applicable. Valid values: `agricultureSource`, `alertsOnly`, `industrialSite`, `riskZone`, `shortHaul`, `undefined`, `workforceSite`, `yard`
31
+ """
32
+
33
+ air_temperature_millicelsius: typing_extensions.Annotated[
34
+ typing.Optional[int], FieldMetadata(alias="airTemperatureMillicelsius")
35
+ ] = pydantic.Field(default=None)
36
+ """
37
+ The air temperature in millicelsius during the idling event. Value is returned only when it is known.
38
+ """
39
+
40
+ asset_id: typing_extensions.Annotated[int, FieldMetadata(alias="assetId")] = pydantic.Field()
41
+ """
42
+ Samsara ID of the asset assigned to the event. Returns vehicle ID at this time.
43
+ """
44
+
45
+ duration_milliseconds: typing_extensions.Annotated[int, FieldMetadata(alias="durationMilliseconds")] = (
46
+ pydantic.Field()
47
+ )
48
+ """
49
+ The duration of the idling event in milliseconds.
50
+ """
51
+
52
+ event_uuid: typing_extensions.Annotated[str, FieldMetadata(alias="eventUuid")] = pydantic.Field()
53
+ """
54
+ Universally unique identifier of the idling event.
55
+ """
56
+
57
+ fuel_consumed_milliliters: typing_extensions.Annotated[float, FieldMetadata(alias="fuelConsumedMilliliters")] = (
58
+ pydantic.Field()
59
+ )
60
+ """
61
+ The amount of fuel consumed in milliliters during the idling event.
62
+ """
63
+
64
+ fuel_cost: typing_extensions.Annotated[FuelCostObjectResponseBody, FieldMetadata(alias="fuelCost")]
65
+ gaseous_fuel_consumed_grams: typing_extensions.Annotated[float, FieldMetadata(alias="gaseousFuelConsumedGrams")] = (
66
+ pydantic.Field()
67
+ )
68
+ """
69
+ The amount of gaseous fuel consumed in grams during the idling event.
70
+ """
71
+
72
+ gaseous_fuel_cost: typing_extensions.Annotated[
73
+ GaseousFuelCostObjectResponseBody, FieldMetadata(alias="gaseousFuelCost")
74
+ ]
75
+ operator_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="operatorId")] = pydantic.Field(
76
+ default=None
77
+ )
78
+ """
79
+ Samsara ID of the operator assigned the event. Returns driver ID at this time. Value is returned when the driver is assigned to the vehicle.
80
+ """
81
+
82
+ pto_state: typing_extensions.Annotated[typing.Literal["active, inactive"], FieldMetadata(alias="ptoState")] = (
83
+ pydantic.Field(default="active, inactive")
84
+ )
85
+ """
86
+ The PTO (Power Take-Off) state during the idling event. Valid values: `active, inactive`
87
+ """
88
+
89
+ start_time: typing_extensions.Annotated[str, FieldMetadata(alias="startTime")] = pydantic.Field()
90
+ """
91
+ The start time of the idling event in RFC 3339 format.
92
+ """
93
+
94
+ if IS_PYDANTIC_V2:
95
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
96
+ else:
97
+
98
+ class Config:
99
+ frozen = True
100
+ smart_union = True
101
+ extra = pydantic.Extra.allow
@@ -0,0 +1,17 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ IdlingEventObjectResponseBodyAddressType = typing.Union[
6
+ typing.Literal[
7
+ "agricultureSource",
8
+ "alertsOnly",
9
+ "industrialSite",
10
+ "riskZone",
11
+ "shortHaul",
12
+ "undefined",
13
+ "workforceSite",
14
+ "yard",
15
+ ],
16
+ typing.Any,
17
+ ]
@@ -0,0 +1,24 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .v_1_messages_response import V1MessagesResponse
8
+
9
+
10
+ class InlineResponse2005(UniversalBaseModel):
11
+ """
12
+ A list of messages.
13
+ """
14
+
15
+ data: typing.Optional[V1MessagesResponse] = None
16
+
17
+ if IS_PYDANTIC_V2:
18
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
19
+ else:
20
+
21
+ class Config:
22
+ frozen = True
23
+ smart_union = True
24
+ extra = pydantic.Extra.allow
@@ -0,0 +1,24 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+
5
+ import pydantic
6
+ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
7
+ from .v_1_messages import V1Messages
8
+
9
+
10
+ class InlineResponse2006(UniversalBaseModel):
11
+ """
12
+ A list of created messages.
13
+ """
14
+
15
+ data: typing.Optional[V1Messages] = None
16
+
17
+ if IS_PYDANTIC_V2:
18
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
19
+ else:
20
+
21
+ class Config:
22
+ frozen = True
23
+ smart_union = True
24
+ extra = pydantic.Extra.allow