samsara-api 3.0.0__py3-none-any.whl → 4.0.1__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.
- samsara/__init__.py +7438 -2443
- samsara/addresses/__init__.py +31 -1
- samsara/addresses/client.py +19 -12
- samsara/addresses/raw_client.py +13 -16
- samsara/addresses/types/__init__.py +32 -2
- samsara/addresses/types/create_address_request_address_types_item.py +9 -1
- samsara/addresses/types/update_address_request_address_types_item.py +9 -1
- samsara/alerts/__init__.py +29 -3
- samsara/alerts/client.py +811 -8
- samsara/alerts/raw_client.py +1837 -0
- samsara/alerts/types/__init__.py +34 -0
- samsara/alerts/types/get_configurations_request_status.py +5 -0
- samsara/assets/__init__.py +40 -9
- samsara/assets/client.py +710 -23
- samsara/assets/raw_client.py +673 -6
- samsara/assets/types/__init__.py +38 -5
- samsara/attributes/__init__.py +50 -16
- samsara/attributes/client.py +82 -96
- samsara/attributes/raw_client.py +57 -104
- samsara/attributes/types/__init__.py +48 -14
- samsara/attributes/types/create_attribute_request_attribute_type.py +3 -1
- samsara/attributes/types/create_attribute_request_unit.py +42 -0
- samsara/attributes/types/delete_attribute_request_entity_type.py +5 -0
- samsara/attributes/types/get_attribute_request_entity_type.py +5 -0
- samsara/attributes/types/get_attributes_by_entity_type_request_entity_type.py +5 -0
- samsara/attributes/types/update_attribute_request_attribute_type.py +3 -1
- samsara/beta_ap_is/__init__.py +70 -0
- samsara/beta_ap_is/client.py +7119 -0
- samsara/beta_ap_is/raw_client.py +16518 -0
- samsara/beta_ap_is/types/__init__.py +70 -0
- samsara/beta_ap_is/types/functions_start_function_run_request_body_params_override.py +21 -0
- samsara/beta_ap_is/types/get_assets_inputs_request_type.py +27 -0
- samsara/beta_ap_is/types/get_driver_efficiency_request_driver_activation_status.py +5 -0
- samsara/beta_ap_is/types/get_hos_eld_events_request_driver_activation_status.py +5 -0
- samsara/beta_ap_is/types/get_jobs_request_status.py +5 -0
- samsara/beta_ap_is/types/get_qualification_records_stream_request_entity_type.py +5 -0
- samsara/beta_ap_is/types/get_qualification_types_request_entity_type.py +5 -0
- samsara/beta_ap_is/types/get_tag_group_safety_scores_request_score_type.py +5 -0
- samsara/beta_ap_is/types/get_tag_safety_scores_request_score_type.py +5 -0
- samsara/beta_ap_is/types/get_trips_request_completion_status.py +5 -0
- samsara/beta_ap_is/types/get_trips_request_query_by.py +5 -0
- samsara/carrier_proposed_assignments/client.py +38 -39
- samsara/carrier_proposed_assignments/raw_client.py +23 -61
- samsara/client.py +950 -152
- samsara/coaching/__init__.py +0 -3
- samsara/coaching/client.py +442 -8
- samsara/coaching/raw_client.py +1043 -0
- samsara/contacts/client.py +48 -51
- samsara/contacts/raw_client.py +29 -61
- samsara/core/__init__.py +76 -21
- samsara/core/client_wrapper.py +20 -10
- samsara/core/force_multipart.py +4 -2
- samsara/core/http_response.py +1 -1
- samsara/core/pagination.py +1 -1
- samsara/core/pydantic_utilities.py +7 -4
- samsara/documents/__init__.py +29 -3
- samsara/documents/client.py +294 -44
- samsara/documents/raw_client.py +503 -53
- samsara/documents/types/__init__.py +30 -1
- samsara/driver_qr_codes/client.py +306 -0
- samsara/driver_qr_codes/raw_client.py +928 -0
- samsara/driver_vehicle_assignments/__init__.py +32 -2
- samsara/driver_vehicle_assignments/client.py +47 -35
- samsara/driver_vehicle_assignments/raw_client.py +19 -19
- samsara/driver_vehicle_assignments/types/__init__.py +33 -3
- samsara/driver_vehicle_assignments/types/get_driver_vehicle_assignments_request_assignment_type.py +10 -0
- samsara/driver_vehicle_assignments/types/get_driver_vehicle_assignments_request_filter_by.py +5 -0
- samsara/drivers/__init__.py +38 -11
- samsara/drivers/client.py +139 -20
- samsara/drivers/raw_client.py +111 -6
- samsara/drivers/types/__init__.py +36 -4
- samsara/equipment/__init__.py +39 -7
- samsara/equipment/client.py +1001 -62
- samsara/equipment/raw_client.py +1010 -70
- samsara/equipment/types/__init__.py +44 -0
- samsara/equipment/types/get_equipment_stats_feed_request_types_item.py +19 -0
- samsara/equipment/types/get_equipment_stats_history_request_types_item.py +19 -0
- samsara/equipment/types/get_equipment_stats_request_types_item.py +19 -0
- samsara/errors/__init__.py +46 -9
- samsara/fleet/__init__.py +34 -0
- samsara/fleet/attributes/client.py +101 -0
- samsara/fleet/attributes/raw_client.py +74 -0
- samsara/fleet/client.py +63 -0
- samsara/fleet/raw_client.py +13 -0
- samsara/forms/__init__.py +30 -0
- samsara/forms/client.py +815 -2
- samsara/forms/raw_client.py +2091 -15
- samsara/forms/types/__init__.py +38 -0
- samsara/fuel_and_energy/__init__.py +46 -0
- samsara/fuel_and_energy/client.py +960 -0
- samsara/fuel_and_energy/raw_client.py +1925 -0
- samsara/fuel_and_energy/types/__init__.py +48 -0
- samsara/fuel_and_energy/types/fuel_purchase_post_fuel_purchase_request_body_fuel_grade.py +7 -0
- samsara/fuel_and_energy/types/get_fuel_energy_vehicle_reports_request_energy_type.py +5 -0
- samsara/gateways/client.py +29 -35
- samsara/gateways/raw_client.py +14 -45
- samsara/hours_of_service/__init__.py +34 -0
- samsara/hours_of_service/client.py +1002 -0
- samsara/hours_of_service/raw_client.py +1381 -0
- samsara/hours_of_service/types/__init__.py +36 -0
- samsara/hours_of_service/types/get_hos_daily_logs_request_driver_activation_status.py +5 -0
- samsara/hubs/client.py +1073 -0
- samsara/hubs/raw_client.py +2106 -0
- samsara/idling/__init__.py +29 -2
- samsara/idling/client.py +36 -30
- samsara/idling/raw_client.py +18 -72
- samsara/idling/types/__init__.py +29 -2
- samsara/idling/types/get_idling_events_request_pto_state.py +5 -0
- samsara/ifta/__init__.py +50 -2
- samsara/ifta/client.py +634 -3
- samsara/ifta/raw_client.py +1432 -0
- samsara/ifta/types/__init__.py +53 -0
- samsara/ifta/types/get_ifta_jurisdiction_reports_request_fuel_type.py +25 -0
- samsara/ifta/types/get_ifta_jurisdiction_reports_request_month.py +21 -0
- samsara/ifta/types/get_ifta_jurisdiction_reports_request_quarter.py +5 -0
- samsara/ifta/types/get_ifta_vehicle_reports_request_fuel_type.py +25 -0
- samsara/ifta/types/get_ifta_vehicle_reports_request_month.py +21 -0
- samsara/ifta/types/get_ifta_vehicle_reports_request_quarter.py +5 -0
- samsara/industrial/client.py +2167 -0
- samsara/industrial/raw_client.py +2463 -0
- samsara/issues/__init__.py +28 -1
- samsara/issues/client.py +39 -35
- samsara/issues/raw_client.py +24 -53
- samsara/issues/types/__init__.py +30 -1
- samsara/legacy/client.py +21 -95
- samsara/legacy/raw_client.py +25 -304
- samsara/legacy_ap_is/__init__.py +34 -0
- samsara/legacy_ap_is/client.py +879 -0
- samsara/legacy_ap_is/raw_client.py +1433 -0
- samsara/legacy_ap_is/types/__init__.py +38 -0
- samsara/legacy_ap_is/types/get_drivers_vehicle_assignments_request_driver_activation_status.py +7 -0
- samsara/live_sharing_links/__init__.py +37 -0
- samsara/live_sharing_links/client.py +548 -0
- samsara/live_sharing_links/raw_client.py +1389 -0
- samsara/live_sharing_links/types/__init__.py +40 -0
- samsara/live_sharing_links/types/get_live_sharing_links_request_type.py +7 -0
- samsara/location_and_speed/client.py +236 -0
- samsara/location_and_speed/raw_client.py +414 -0
- samsara/maintenance/__init__.py +30 -20
- samsara/maintenance/client.py +1198 -8
- samsara/maintenance/raw_client.py +2249 -0
- samsara/maintenance/types/__init__.py +34 -0
- samsara/media/__init__.py +52 -0
- samsara/media/client.py +500 -0
- samsara/media/raw_client.py +1082 -0
- samsara/media/types/__init__.py +54 -0
- samsara/media/types/list_uploaded_media_request_inputs_item.py +7 -0
- samsara/media/types/list_uploaded_media_request_media_types_item.py +5 -0
- samsara/media/types/list_uploaded_media_request_trigger_reasons_item.py +17 -0
- samsara/media/types/media_retrieval_post_media_retrieval_request_body_inputs_item.py +7 -0
- samsara/messages/client.py +272 -0
- samsara/messages/raw_client.py +273 -0
- samsara/organization_info/client.py +112 -0
- samsara/organization_info/raw_client.py +101 -0
- samsara/plans/client.py +312 -0
- samsara/plans/raw_client.py +700 -0
- samsara/preview_ap_is/client.py +367 -0
- samsara/preview_ap_is/raw_client.py +956 -0
- samsara/routes/__init__.py +0 -3
- samsara/routes/client.py +459 -50
- samsara/routes/raw_client.py +913 -140
- samsara/safety/client.py +662 -0
- samsara/safety/raw_client.py +869 -0
- samsara/sensors/__init__.py +34 -0
- samsara/sensors/client.py +680 -0
- samsara/sensors/raw_client.py +746 -0
- samsara/sensors/types/__init__.py +34 -0
- samsara/sensors/types/inline_object_6_fill_missing.py +5 -0
- samsara/settings/__init__.py +0 -3
- samsara/settings/client.py +579 -13
- samsara/settings/raw_client.py +1655 -0
- samsara/speeding_intervals/__init__.py +29 -2
- samsara/speeding_intervals/client.py +20 -28
- samsara/speeding_intervals/raw_client.py +16 -58
- samsara/speeding_intervals/types/__init__.py +31 -2
- samsara/speeding_intervals/types/get_speeding_intervals_request_query_by.py +5 -0
- samsara/tachograph_eu_only/client.py +494 -0
- samsara/tachograph_eu_only/raw_client.py +475 -0
- samsara/tags/client.py +53 -58
- samsara/tags/raw_client.py +29 -63
- samsara/trailer_assignments/client.py +331 -0
- samsara/trailer_assignments/raw_client.py +313 -0
- samsara/trailers/client.py +47 -47
- samsara/trailers/raw_client.py +18 -53
- samsara/trips/__init__.py +0 -3
- samsara/trips/client.py +55 -111
- samsara/trips/raw_client.py +58 -349
- samsara/types/__init__.py +10049 -4134
- samsara/types/address.py +5 -5
- samsara/types/address_address_types_item.py +9 -1
- samsara/types/address_external_ids.py +21 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_bad_gateway_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_gateway_timeout_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_internal_server_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_method_not_allowed_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_not_found_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_not_implemented_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_response_body.py +22 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_service_unavailable_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_too_many_requests_error_response_body.py +33 -0
- samsara/types/aemp_equipment_get_aemp_equipment_list_unauthorized_error_response_body.py +33 -0
- samsara/types/aemp_equipment_with_additional_fields_response_body.py +48 -0
- samsara/types/aemp_fleet_list_response_body.py +49 -0
- samsara/types/aemp_link_response_body.py +31 -0
- samsara/types/anticipation_brake_event_count.py +3 -0
- samsara/types/appointment_window_request_body.py +34 -0
- samsara/types/appointment_window_response_body.py +34 -0
- samsara/types/asset_data_input.py +45 -0
- samsara/types/asset_data_input_last_point.py +28 -0
- samsara/types/asset_data_output.py +45 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_bad_gateway_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_gateway_timeout_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_internal_server_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_method_not_allowed_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_not_found_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_not_implemented_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_response_body.py +23 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_service_unavailable_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_too_many_requests_error_response_body.py +33 -0
- samsara/types/asset_data_outputs_patch_asset_data_outputs_unauthorized_error_response_body.py +33 -0
- samsara/types/asset_location.py +35 -0
- samsara/types/asset_name.py +3 -0
- samsara/types/asset_response.py +71 -0
- samsara/types/asset_response_body.py +7 -0
- samsara/types/asset_response_location_data_input.py +26 -0
- samsara/types/asset_response_parent_asset.py +26 -0
- samsara/types/asset_response_running_status_data_input.py +26 -0
- samsara/types/assets_location_link_request_config_object.py +39 -0
- samsara/types/assets_location_link_response_config_object_response_body.py +40 -0
- samsara/types/attribute.py +10 -12
- samsara/types/attribute_attribute_type.py +3 -1
- samsara/types/attribute_entity.py +3 -3
- samsara/types/attribute_unit.py +42 -0
- samsara/types/base_route_response_object_response_body.py +7 -0
- samsara/types/coasting_duration_ms.py +3 -0
- samsara/types/continuous_reading_alert_threshold_response_body.py +1 -1
- samsara/types/continuous_reading_alert_threshold_response_body_unit.py +15 -0
- samsara/types/create_driver_auth_token_response_response_body.py +33 -0
- samsara/types/cruise_control_duration_ms.py +3 -0
- samsara/types/cumulative_operating_hours_response_body.py +35 -0
- samsara/types/custom_metadata.py +5 -0
- samsara/types/data_input_list_response.py +26 -0
- samsara/types/data_input_response.py +19 -0
- samsara/types/data_input_response_all_of.py +59 -0
- samsara/types/data_input_snapshot.py +19 -0
- samsara/types/data_input_snapshot_all_of.py +40 -0
- samsara/types/data_input_snapshot_response.py +26 -0
- samsara/types/data_input_tiny_response.py +52 -0
- samsara/types/data_inputs_tiny_response.py +26 -0
- samsara/types/def_remaining_response_body.py +35 -0
- samsara/types/detection_log_asset_object_response_body.py +43 -0
- samsara/types/detection_log_detection_object_response_body.py +65 -0
- samsara/types/detection_log_detection_object_response_body_trigger_detection_label.py +33 -0
- samsara/types/detection_log_driver_object_response_body.py +52 -0
- samsara/types/detection_log_get_detections_bad_gateway_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_gateway_timeout_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_internal_server_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_method_not_allowed_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_not_found_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_not_implemented_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_response_body.py +26 -0
- samsara/types/detection_log_get_detections_service_unavailable_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_too_many_requests_error_response_body.py +33 -0
- samsara/types/detection_log_get_detections_unauthorized_error_response_body.py +33 -0
- samsara/types/detection_log_safety_event_object_response_body.py +39 -0
- samsara/types/detection_log_safety_event_object_response_body_inbox_filter_reason.py +21 -0
- samsara/types/device_response_response_body.py +1 -1
- samsara/types/device_response_response_body_model.py +5 -0
- samsara/types/distance_driven_meters.py +3 -0
- samsara/types/distance_response_body.py +42 -0
- samsara/types/drive_time_duration_ms.py +3 -0
- samsara/types/driver.py +8 -0
- samsara/types/driver_app_sign_in_response_body.py +6 -0
- samsara/types/driver_efficiencies_response.py +26 -0
- samsara/types/driver_efficiencies_response_data.py +42 -0
- samsara/types/driver_efficiency.py +79 -0
- samsara/types/driver_efficiency_data_object_response_body.py +84 -0
- samsara/types/driver_efficiency_difficulty_score_data_object_response_body.py +44 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_bad_gateway_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_gateway_timeout_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_internal_server_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_method_not_allowed_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_not_found_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_not_implemented_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_response_body.py +28 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_service_unavailable_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_too_many_requests_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_drivers_unauthorized_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_bad_gateway_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_gateway_timeout_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_internal_server_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_method_not_allowed_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_not_found_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_not_implemented_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_response_body.py +28 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_service_unavailable_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_too_many_requests_error_response_body.py +33 -0
- samsara/types/driver_efficiency_get_driver_efficiency_by_vehicles_unauthorized_error_response_body.py +33 -0
- samsara/types/driver_efficiency_percentage_data_object_response_body.py +84 -0
- samsara/types/driver_efficiency_raw_data_object_response_body.py +119 -0
- samsara/types/driver_has_vehicle_unpinning_enabled.py +3 -0
- samsara/types/driver_profile_image_base_64.py +3 -0
- samsara/types/driver_profile_image_url.py +3 -0
- samsara/types/driver_safety_score_response_body.py +59 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_bad_gateway_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_gateway_timeout_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_internal_server_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_method_not_allowed_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_not_found_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_not_implemented_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_response_body.py +20 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_service_unavailable_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_too_many_requests_error_response_body.py +33 -0
- samsara/types/drivers_auth_token_create_driver_auth_token_unauthorized_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_bad_gateway_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_gateway_timeout_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_internal_server_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_method_not_allowed_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_not_found_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_not_implemented_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_service_unavailable_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_too_many_requests_error_response_body.py +33 -0
- samsara/types/engine_immobilizer_update_engine_immobilizer_state_unauthorized_error_response_body.py +33 -0
- samsara/types/engine_status_response_body.py +35 -0
- samsara/types/equipment_header_with_additional_fields_response_body.py +63 -0
- samsara/types/equipment_patch_equipment_bad_gateway_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_gateway_timeout_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_internal_server_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_method_not_allowed_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_not_found_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_not_implemented_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_response_body.py +20 -0
- samsara/types/equipment_patch_equipment_service_unavailable_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_too_many_requests_error_response_body.py +33 -0
- samsara/types/equipment_patch_equipment_unauthorized_error_response_body.py +33 -0
- samsara/types/equipment_with_attributes_response_object_response_body.py +68 -0
- samsara/types/extended_driver_tiny_response.py +46 -0
- samsara/types/extended_driver_tiny_response_external_ids.py +21 -0
- samsara/types/fft_spectra_data_point.py +30 -0
- samsara/types/fft_spectra_data_point_fft_spectra.py +41 -0
- samsara/types/fleet_device_object_response_body.py +31 -0
- samsara/types/form_submission_request_media_item_object_request_body.py +33 -0
- samsara/types/form_submission_request_media_value_object_request_body.py +31 -0
- samsara/types/form_submission_request_signature_value_object_request_body.py +24 -0
- samsara/types/form_template_response_object_response_body.py +10 -0
- samsara/types/form_template_response_object_response_body_form_category.py +7 -0
- samsara/types/form_updated_response_body.py +24 -0
- samsara/types/fuel_consumed_ml.py +3 -0
- samsara/types/fuel_remaining_response_body.py +35 -0
- samsara/types/functions_start_function_run_bad_gateway_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_gateway_timeout_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_internal_server_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_method_not_allowed_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_not_found_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_not_implemented_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_response_body.py +20 -0
- samsara/types/functions_start_function_run_service_unavailable_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_too_many_requests_error_response_body.py +33 -0
- samsara/types/functions_start_function_run_unauthorized_error_response_body.py +33 -0
- samsara/types/gateway_details_response_response_body.py +1 -1
- samsara/types/gateway_details_response_response_body_gateway_battery_state.py +3 -1
- samsara/types/goa_attribute_tiny.py +47 -0
- samsara/types/goa_form_tiny_response_response_body.py +26 -0
- samsara/types/goa_issue_tiny_response_response_body.py +26 -0
- samsara/types/green_band_driving_duration_ms.py +3 -0
- samsara/types/harsh_event_trigger_details_object_request_body_types_item.py +2 -0
- samsara/types/harsh_event_trigger_details_object_response_body_types_item.py +2 -0
- samsara/types/health_response_response_body.py +11 -1
- samsara/types/health_response_response_body_recommended_action.py +10 -0
- samsara/types/high_torque_ms.py +3 -0
- samsara/types/hos_daily_logs_update_shipping_docs_bad_gateway_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_internal_server_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_not_found_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_not_implemented_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_response_body.py +20 -0
- samsara/types/hos_daily_logs_update_shipping_docs_service_unavailable_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_too_many_requests_error_response_body.py +33 -0
- samsara/types/hos_daily_logs_update_shipping_docs_unauthorized_error_response_body.py +33 -0
- samsara/types/hos_drivers_eld_event_object_response_body.py +54 -0
- samsara/types/hos_drivers_eld_event_object_response_body_driver_activation_status.py +7 -0
- samsara/types/hos_eld_event_location_object_response_body.py +46 -0
- samsara/types/hos_eld_event_object_response_body.py +98 -0
- samsara/types/hos_eld_event_object_response_body_malfunction_diagnostic_code.py +7 -0
- samsara/types/hos_eld_event_remark_object_response_body.py +36 -0
- samsara/types/hos_eld_events_get_hos_eld_events_bad_gateway_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_internal_server_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_not_found_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_not_implemented_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_response_body.py +26 -0
- samsara/types/hos_eld_events_get_hos_eld_events_service_unavailable_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_too_many_requests_error_response_body.py +33 -0
- samsara/types/hos_eld_events_get_hos_eld_events_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_internal_server_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_not_found_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_response_body.py +26 -0
- samsara/types/hub_capacities_list_hub_capacities_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_capacities_list_hub_capacities_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_capacity_object_response_body.py +54 -0
- samsara/types/hub_location_created_object_response_body.py +105 -0
- samsara/types/hub_location_input_object_request_body.py +94 -0
- samsara/types/hub_location_object_response_body.py +105 -0
- samsara/types/hub_location_service_window_input_request_body.py +38 -0
- samsara/types/hub_location_updated_object_response_body.py +105 -0
- samsara/types/hub_locations_create_hub_locations_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_internal_server_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_not_found_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_response_body.py +23 -0
- samsara/types/hub_locations_create_hub_locations_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_locations_create_hub_locations_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_internal_server_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_not_found_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_response_body.py +26 -0
- samsara/types/hub_locations_list_hub_locations_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_locations_list_hub_locations_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_internal_server_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_not_found_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_response_body.py +20 -0
- samsara/types/hub_locations_update_hub_location_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_locations_update_hub_location_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_object_response_body.py +49 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_internal_server_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_not_found_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_response_body.py +26 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_plan_routes_list_hub_plan_routes_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_internal_server_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_not_found_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_response_body.py +20 -0
- samsara/types/hub_plans_create_hub_plan_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_plans_create_hub_plan_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_internal_server_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_not_found_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_response_body.py +26 -0
- samsara/types/hub_plans_list_hub_plans_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_plans_list_hub_plans_unauthorized_error_response_body.py +33 -0
- samsara/types/hub_skill_object_response_body.py +49 -0
- samsara/types/hub_skills_list_hub_skills_bad_gateway_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_internal_server_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_not_found_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_not_implemented_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_response_body.py +26 -0
- samsara/types/hub_skills_list_hub_skills_service_unavailable_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_too_many_requests_error_response_body.py +33 -0
- samsara/types/hub_skills_list_hub_skills_unauthorized_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_bad_gateway_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_gateway_timeout_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_internal_server_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_method_not_allowed_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_not_found_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_not_implemented_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_response_body.py +26 -0
- samsara/types/hubs_list_hubs_service_unavailable_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_too_many_requests_error_response_body.py +33 -0
- samsara/types/hubs_list_hubs_unauthorized_error_response_body.py +33 -0
- samsara/types/idle_time_duration_ms.py +3 -0
- samsara/types/idling_event_object_response_body.py +1 -1
- samsara/types/idling_event_object_response_body_address_type.py +2 -0
- samsara/types/industrial_asset_object_response_body.py +31 -0
- samsara/types/inline_response_200.py +20 -0
- samsara/types/inline_response_2001.py +20 -0
- samsara/types/inline_response_2002.py +22 -0
- samsara/types/inline_response_2003.py +22 -0
- samsara/types/inline_response_2004.py +20 -0
- samsara/types/inline_response_2007.py +22 -0
- samsara/types/inline_response_2008.py +20 -0
- samsara/types/inline_response_2009.py +20 -0
- samsara/types/j_1939_d_1_status_data_point.py +29 -0
- samsara/types/j_1939_d_1_status_data_point_value.py +34 -0
- samsara/types/job_location_response_object_response_body.py +41 -0
- samsara/types/job_response_object_response_body.py +106 -0
- samsara/types/job_response_object_response_body_status.py +5 -0
- samsara/types/jobs_create_job_bad_gateway_error_response_body.py +33 -0
- samsara/types/jobs_create_job_gateway_timeout_error_response_body.py +33 -0
- samsara/types/jobs_create_job_internal_server_error_response_body.py +33 -0
- samsara/types/jobs_create_job_method_not_allowed_error_response_body.py +33 -0
- samsara/types/jobs_create_job_not_found_error_response_body.py +33 -0
- samsara/types/jobs_create_job_not_implemented_error_response_body.py +33 -0
- samsara/types/jobs_create_job_response_body.py +31 -0
- samsara/types/jobs_create_job_service_unavailable_error_response_body.py +33 -0
- samsara/types/jobs_create_job_too_many_requests_error_response_body.py +33 -0
- samsara/types/jobs_create_job_unauthorized_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_bad_gateway_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_gateway_timeout_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_internal_server_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_method_not_allowed_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_not_found_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_not_implemented_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_response_body.py +29 -0
- samsara/types/jobs_delete_job_service_unavailable_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_too_many_requests_error_response_body.py +33 -0
- samsara/types/jobs_delete_job_unauthorized_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_bad_gateway_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_gateway_timeout_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_internal_server_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_method_not_allowed_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_not_found_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_not_implemented_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_response_body.py +37 -0
- samsara/types/jobs_get_jobs_service_unavailable_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_too_many_requests_error_response_body.py +33 -0
- samsara/types/jobs_get_jobs_unauthorized_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_bad_gateway_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_gateway_timeout_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_internal_server_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_method_not_allowed_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_not_found_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_not_implemented_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_response_body.py +31 -0
- samsara/types/jobs_patch_job_service_unavailable_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_too_many_requests_error_response_body.py +33 -0
- samsara/types/jobs_patch_job_unauthorized_error_response_body.py +33 -0
- samsara/types/latitude.py +3 -0
- samsara/types/list_hub_capacities_response_pagination_response_body.py +35 -0
- samsara/types/list_hub_locations_response_pagination_response_body.py +35 -0
- samsara/types/list_hub_plan_routes_response_pagination_response_body.py +35 -0
- samsara/types/list_hub_plans_response_pagination_response_body.py +35 -0
- samsara/types/list_hub_skills_response_pagination_response_body.py +35 -0
- samsara/types/list_hubs_response_pagination_response_body.py +35 -0
- samsara/types/list_industrial_assets_response.py +22 -0
- samsara/types/live_sharing_link_full_response_object_response_body.py +5 -2
- samsara/types/location_data_point.py +30 -0
- samsara/types/location_data_point_gps_location.py +57 -0
- samsara/types/location_data_point_gps_location_place.py +60 -0
- samsara/types/location_object_request_body_address_types_item.py +2 -0
- samsara/types/location_object_response_body_address_types_item.py +2 -0
- samsara/types/location_response_body.py +42 -0
- samsara/types/location_type.py +5 -0
- samsara/types/longitude.py +3 -0
- samsara/types/media_object_response_body.py +10 -2
- samsara/types/media_object_response_body_camera_role.py +28 -0
- samsara/types/media_object_response_body_input.py +3 -1
- samsara/types/media_object_response_body_status.py +3 -1
- samsara/types/number_data_point.py +28 -0
- samsara/types/order_input_object_request_body.py +59 -0
- samsara/types/order_object_response_body.py +75 -0
- samsara/types/order_quantity_input_request_body.py +33 -0
- samsara/types/order_quantity_response_body.py +33 -0
- samsara/types/order_task_object_response_body.py +54 -0
- samsara/types/order_task_request_body.py +67 -0
- samsara/types/order_task_request_body_position.py +5 -0
- samsara/types/order_task_response_body.py +67 -0
- samsara/types/order_task_response_body_position.py +5 -0
- samsara/types/order_task_skill_object_response_body.py +31 -0
- samsara/types/over_speed_ms.py +3 -0
- samsara/types/parent_id.py +3 -0
- samsara/types/part_instance_input_object_request_body.py +45 -0
- samsara/types/part_instance_object_response_body.py +45 -0
- samsara/types/patch_asset_data_outputs_single_response_response_body.py +40 -0
- samsara/types/patch_job_object_request_body.py +89 -0
- samsara/types/patch_job_objectjob_location_request_object_request_body.py +41 -0
- samsara/types/patch_shipping_docs_response_body_response_body.py +93 -0
- samsara/types/plan_object_response_body.py +49 -0
- samsara/types/plan_orders_create_plan_orders_bad_gateway_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_gateway_timeout_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_internal_server_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_method_not_allowed_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_not_found_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_not_implemented_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_response_body.py +23 -0
- samsara/types/plan_orders_create_plan_orders_service_unavailable_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_too_many_requests_error_response_body.py +33 -0
- samsara/types/plan_orders_create_plan_orders_unauthorized_error_response_body.py +33 -0
- samsara/types/post_fuel_purchase_request_body_discount_request_body.py +34 -0
- samsara/types/post_fuel_purchase_request_body_discount_request_body_currency.py +7 -0
- samsara/types/post_job_object_request_body.py +85 -0
- samsara/types/post_job_objectjob_location_request_object_request_body.py +41 -0
- samsara/types/power_take_off_duration_ms.py +3 -0
- samsara/types/qualification_field_input_object_response_body.py +75 -0
- samsara/types/qualification_field_input_object_response_body_type.py +8 -0
- samsara/types/qualification_owner_object_response_body.py +43 -0
- samsara/types/qualification_owner_object_response_body_entity_type.py +5 -0
- samsara/types/qualification_owner_request_object_request_body.py +38 -0
- samsara/types/qualification_owner_request_object_request_body_entity_type.py +5 -0
- samsara/types/qualification_record_request_field_input_object_request_body.py +77 -0
- samsara/types/qualification_record_request_field_input_object_request_body_type.py +8 -0
- samsara/types/qualification_record_response_object_response_body.py +84 -0
- samsara/types/qualification_record_response_object_response_body_record_status.py +7 -0
- samsara/types/qualification_type_reference_object_response_body.py +40 -0
- samsara/types/qualification_type_request_object_request_body.py +26 -0
- samsara/types/qualification_type_response_object_response_body.py +69 -0
- samsara/types/qualification_type_response_object_response_body_entity_type.py +5 -0
- samsara/types/qualifications_archive_qualification_record_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_archive_qualification_record_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_delete_qualification_record_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_response_body.py +23 -0
- samsara/types/qualifications_get_qualification_records_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_response_body.py +26 -0
- samsara/types/qualifications_get_qualification_records_stream_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_stream_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_records_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_response_body.py +26 -0
- samsara/types/qualifications_get_qualification_types_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_get_qualification_types_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_response_body.py +20 -0
- samsara/types/qualifications_patch_qualification_record_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_patch_qualification_record_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_response_body.py +20 -0
- samsara/types/qualifications_post_qualification_record_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_post_qualification_record_unauthorized_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_bad_gateway_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_gateway_timeout_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_internal_server_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_method_not_allowed_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_not_found_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_not_implemented_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_service_unavailable_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_too_many_requests_error_response_body.py +33 -0
- samsara/types/qualifications_unarchive_qualification_record_unauthorized_error_response_body.py +33 -0
- samsara/types/quantity_object_response_body.py +33 -0
- samsara/types/reading_datapoint_request_body.py +50 -0
- samsara/types/reading_definition_response_body.py +5 -0
- samsara/types/reading_trigger_continuous_value_object_request_body.py +1 -1
- samsara/types/reading_trigger_continuous_value_object_request_body_unit.py +15 -0
- samsara/types/reading_trigger_continuous_value_object_response_body.py +1 -1
- samsara/types/reading_trigger_continuous_value_object_response_body_unit.py +15 -0
- samsara/types/readings_post_readings_bad_gateway_error_response_body.py +33 -0
- samsara/types/readings_post_readings_gateway_timeout_error_response_body.py +33 -0
- samsara/types/readings_post_readings_internal_server_error_response_body.py +33 -0
- samsara/types/readings_post_readings_method_not_allowed_error_response_body.py +33 -0
- samsara/types/readings_post_readings_not_found_error_response_body.py +33 -0
- samsara/types/readings_post_readings_not_implemented_error_response_body.py +33 -0
- samsara/types/readings_post_readings_service_unavailable_error_response_body.py +33 -0
- samsara/types/readings_post_readings_too_many_requests_error_response_body.py +33 -0
- samsara/types/readings_post_readings_unauthorized_error_response_body.py +33 -0
- samsara/types/reverse_geo_object_response_body.py +30 -0
- samsara/types/route_object_response_body.py +124 -0
- samsara/types/route_stop_object_response_body.py +71 -0
- samsara/types/routes_single_use_address_object_request_body.py +9 -0
- samsara/types/routes_single_use_address_object_response_body.py +9 -0
- samsara/types/routes_stop_response_object_response_body.py +12 -0
- samsara/types/safety_event_behavior_labels_response_body.py +1 -1
- samsara/types/safety_event_behavior_labels_response_body_type.py +1 -0
- samsara/types/safety_event_dismissal_reason_response_body.py +32 -0
- samsara/types/safety_event_dismissal_reason_response_body_code.py +7 -0
- samsara/types/safety_event_v_2_asset_object_response_body.py +63 -0
- samsara/types/safety_event_v_2_asset_object_response_body_type.py +7 -0
- samsara/types/safety_event_v_2_behavior_labels_response_body.py +33 -0
- samsara/types/safety_event_v_2_behavior_labels_response_body_label.py +64 -0
- samsara/types/safety_event_v_2_behavior_labels_response_body_source.py +5 -0
- samsara/types/safety_event_v_2_context_labels_response_body.py +38 -0
- samsara/types/safety_event_v_2_driver_object_response_body.py +52 -0
- samsara/types/safety_event_v_2_object_response_body.py +134 -0
- samsara/types/safety_event_v_2_object_response_body_event_state.py +10 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_internal_server_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_not_found_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_response_body.py +26 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_internal_server_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_not_found_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_response_body.py +26 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_stream_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_events_v_2_get_safety_events_v_2_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_score_behavior_object_response_body.py +41 -0
- samsara/types/safety_score_behavior_object_response_body_behavior_type.py +34 -0
- samsara/types/safety_score_speeding_object_response_body.py +43 -0
- samsara/types/safety_score_speeding_object_response_body_speeding_type.py +7 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_response_body.py +26 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_score_trips_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_response_body.py +26 -0
- samsara/types/safety_scores_get_driver_safety_scores_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_driver_safety_scores_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_response_body.py +20 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_group_safety_scores_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_response_body.py +26 -0
- samsara/types/safety_scores_get_tag_safety_scores_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_tag_safety_scores_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_response_body.py +26 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_score_trips_unauthorized_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_bad_gateway_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_gateway_timeout_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_internal_server_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_method_not_allowed_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_not_found_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_not_implemented_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_response_body.py +26 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_service_unavailable_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_too_many_requests_error_response_body.py +33 -0
- samsara/types/safety_scores_get_vehicle_safety_scores_unauthorized_error_response_body.py +33 -0
- samsara/types/service_task_instance_input_object_request_body.py +6 -0
- samsara/types/service_task_instance_object_response_body.py +6 -0
- samsara/types/service_window_object_response_body.py +38 -0
- samsara/types/single_driver_efficiency_by_driver_data_object_response_body.py +47 -0
- samsara/types/single_driver_efficiency_by_vehicle_data_object_response_body.py +46 -0
- samsara/types/single_use_location_object_response_body.py +36 -0
- samsara/types/skill_object_response_body.py +31 -0
- samsara/types/standard_delete_response.py +3 -0
- samsara/types/start_function_run_response_body_response_body.py +28 -0
- samsara/types/string_data_point.py +28 -0
- samsara/types/tag_group_safety_score_response_body.py +54 -0
- samsara/types/tag_ids.py +5 -0
- samsara/types/tag_safety_score_response_body.py +59 -0
- samsara/types/tire_fault_code_details_object_request_body_specific_tire_fault_codes_item.py +2 -0
- samsara/types/tire_fault_code_details_object_response_body_specific_tire_fault_codes_item.py +2 -0
- samsara/types/total_brake_event_count.py +3 -0
- samsara/types/trailer_stat_decoration_response_body.py +145 -0
- samsara/types/trailer_stat_gps_odometer_meters_type_response_body.py +31 -0
- samsara/types/trailer_stat_gps_odometer_meters_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_gps_type_response_body.py +56 -0
- samsara/types/trailer_stat_gps_with_decorations_type_response_body.py +58 -0
- samsara/types/trailer_stat_reefer_alarm_response_body.py +39 -0
- samsara/types/trailer_stat_reefer_alarm_type_response_body.py +32 -0
- samsara/types/trailer_stat_reefer_alarm_with_decorations_type_response_body.py +34 -0
- samsara/types/trailer_stat_reefer_ambient_air_temperature_milli_c_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_ambient_air_temperature_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_door_state_zone_1_type_response_body.py +34 -0
- samsara/types/trailer_stat_reefer_door_state_zone_1_type_response_body_value.py +5 -0
- samsara/types/trailer_stat_reefer_door_state_zone_1_with_decorations_type_response_body.py +36 -0
- samsara/types/trailer_stat_reefer_door_state_zone_1_with_decorations_type_response_body_value.py +7 -0
- samsara/types/trailer_stat_reefer_door_state_zone_2_type_response_body.py +34 -0
- samsara/types/trailer_stat_reefer_door_state_zone_2_type_response_body_value.py +5 -0
- samsara/types/trailer_stat_reefer_door_state_zone_2_with_decorations_type_response_body.py +36 -0
- samsara/types/trailer_stat_reefer_door_state_zone_2_with_decorations_type_response_body_value.py +7 -0
- samsara/types/trailer_stat_reefer_door_state_zone_3_type_response_body.py +34 -0
- samsara/types/trailer_stat_reefer_door_state_zone_3_type_response_body_value.py +5 -0
- samsara/types/trailer_stat_reefer_door_state_zone_3_with_decorations_type_response_body.py +36 -0
- samsara/types/trailer_stat_reefer_door_state_zone_3_with_decorations_type_response_body_value.py +7 -0
- samsara/types/trailer_stat_reefer_fuel_percent_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_fuel_percent_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_obd_engine_seconds_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_obd_engine_seconds_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_1_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_1_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_2_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_2_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_3_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_return_air_temperature_milli_c_zone_3_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_run_mode_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_run_mode_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_1_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_1_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_2_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_2_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_3_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_set_point_temperature_milli_c_zone_3_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_state_type_response_body.py +40 -0
- samsara/types/trailer_stat_reefer_state_with_decorations_type_response_body.py +42 -0
- samsara/types/trailer_stat_reefer_state_zone_1_type_response_body.py +40 -0
- samsara/types/trailer_stat_reefer_state_zone_1_with_decorations_type_response_body.py +42 -0
- samsara/types/trailer_stat_reefer_state_zone_2_type_response_body.py +40 -0
- samsara/types/trailer_stat_reefer_state_zone_2_with_decorations_type_response_body.py +42 -0
- samsara/types/trailer_stat_reefer_state_zone_3_type_response_body.py +40 -0
- samsara/types/trailer_stat_reefer_state_zone_3_with_decorations_type_response_body.py +42 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_1_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_1_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_2_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_2_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_3_type_response_body.py +31 -0
- samsara/types/trailer_stat_reefer_supply_air_temperature_milli_c_zone_3_with_decorations_type_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_bad_gateway_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_gateway_timeout_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_internal_server_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_method_not_allowed_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_not_found_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_not_implemented_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_response_body.py +26 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_service_unavailable_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_too_many_requests_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_feed_unauthorized_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_bad_gateway_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_gateway_timeout_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_internal_server_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_method_not_allowed_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_not_found_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_not_implemented_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_response_body.py +26 -0
- samsara/types/trailer_stats_get_trailer_stats_history_service_unavailable_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_too_many_requests_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_history_unauthorized_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_bad_gateway_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_gateway_timeout_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_internal_server_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_method_not_allowed_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_not_found_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_not_implemented_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_response_body.py +26 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_service_unavailable_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_too_many_requests_error_response_body.py +33 -0
- samsara/types/trailer_stats_get_trailer_stats_snapshot_unauthorized_error_response_body.py +33 -0
- samsara/types/trailer_stats_object_response_body.py +281 -0
- samsara/types/trailer_stats_snapshot_object_response_body.py +155 -0
- samsara/types/trips_breakdown_response_body.py +67 -0
- samsara/types/unit_response_body.py +2 -2
- samsara/types/unit_response_body_base_unit.py +15 -0
- samsara/types/unit_response_body_measurement_type.py +4 -0
- samsara/types/update_engine_immobilizer_relay_state_request_body_request_body.py +36 -0
- samsara/types/update_engine_immobilizer_relay_state_request_body_request_body_id.py +5 -0
- samsara/types/update_hub_location_request_body_request_body.py +93 -0
- samsara/types/uploaded_media_object_response_body.py +9 -1
- samsara/types/uploaded_media_object_response_body_camera_role.py +28 -0
- samsara/types/uploaded_media_object_response_body_input.py +2 -1
- samsara/types/v_1_asset.py +56 -0
- samsara/types/v_1_asset_cable.py +30 -0
- samsara/types/v_1_asset_current_location.py +52 -0
- samsara/types/v_1_asset_current_locations_response.py +55 -0
- samsara/types/v_1_asset_location_response.py +7 -0
- samsara/types/v_1_asset_location_response_item.py +50 -0
- samsara/types/v_1_asset_reefer_response.py +45 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats.py +67 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_alarms.py +43 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_alarms_1.py +28 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_engine_hours.py +33 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_fuel_percentage.py +33 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_power_status.py +31 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_return_air_temp.py +33 -0
- samsara/types/v_1_asset_reefer_response_reefer_stats_set_point.py +33 -0
- samsara/types/v_1_assets_reefer.py +45 -0
- samsara/types/v_1_assets_reefer_reefer_stats.py +91 -0
- samsara/types/v_1_assets_reefer_reefer_stats_ambient_air_temperature.py +33 -0
- samsara/types/v_1_assets_reefer_reefer_stats_discharge_air_temperature.py +33 -0
- samsara/types/v_1_assets_reefer_reefer_stats_power_status.py +32 -0
- samsara/types/v_1_assets_reefer_reefer_stats_power_status_status.py +7 -0
- samsara/types/v_1_cargo_response.py +33 -0
- samsara/types/v_1_cargo_response_sensors.py +64 -0
- samsara/types/v_1_door_response.py +33 -0
- samsara/types/v_1_door_response_sensors.py +57 -0
- samsara/types/v_1_driver_safety_score_response.py +104 -0
- samsara/types/v_1_hos_authentication_logs_response.py +25 -0
- samsara/types/v_1_hos_authentication_logs_response_authentication_logs.py +55 -0
- samsara/types/v_1_humidity_response.py +33 -0
- samsara/types/v_1_humidity_response_sensors.py +55 -0
- samsara/types/v_1_machine.py +36 -0
- samsara/types/v_1_machine_history_response.py +24 -0
- samsara/types/v_1_machine_history_response_machines.py +33 -0
- samsara/types/v_1_machine_history_response_vibrations.py +24 -0
- samsara/types/v_1_pagination.py +39 -0
- samsara/types/v_1_programs_for_the_camera_response.py +7 -0
- samsara/types/v_1_programs_for_the_camera_response_item.py +22 -0
- samsara/types/v_1_safety_report_harsh_event.py +44 -0
- samsara/types/v_1_sensor.py +40 -0
- samsara/types/v_1_sensor_history_response.py +24 -0
- samsara/types/v_1_sensor_history_response_results.py +31 -0
- samsara/types/v_1_sensors_history_series.py +34 -0
- samsara/types/v_1_sensors_history_series_field.py +25 -0
- samsara/types/v_1_temperature_response.py +33 -0
- samsara/types/v_1_temperature_response_sensors.py +71 -0
- samsara/types/v_1_trailer_assignment_response.py +40 -0
- samsara/types/v_1_trailer_assignments_response.py +19 -0
- samsara/types/v_1_trailer_assignments_response_all_of.py +24 -0
- samsara/types/v_1_trailer_base.py +27 -0
- samsara/types/v_1_trip_response.py +24 -0
- samsara/types/v_1_trip_response_end_address.py +36 -0
- samsara/types/v_1_trip_response_end_coordinates.py +24 -0
- samsara/types/v_1_trip_response_start_address.py +36 -0
- samsara/types/v_1_trip_response_start_coordinates.py +24 -0
- samsara/types/v_1_trip_response_trips.py +119 -0
- samsara/types/v_1_vehicle_harsh_event_response.py +64 -0
- samsara/types/v_1_vehicle_harsh_event_response_location.py +32 -0
- samsara/types/v_1_vehicle_maintenance.py +33 -0
- samsara/types/v_1_vehicle_maintenance_j_1939.py +36 -0
- samsara/types/v_1_vehicle_maintenance_j_1939_check_engine_light.py +28 -0
- samsara/types/v_1_vehicle_maintenance_j_1939_diagnostic_trouble_codes.py +26 -0
- samsara/types/v_1_vehicle_maintenance_passenger.py +38 -0
- samsara/types/v_1_vehicle_maintenance_passenger_check_engine_light.py +25 -0
- samsara/types/v_1_vehicle_maintenance_passenger_diagnostic_trouble_codes.py +23 -0
- samsara/types/v_1_vehicle_safety_score_response.py +104 -0
- samsara/types/v_1_vision_cameras_response.py +7 -0
- samsara/types/v_1_vision_cameras_response_item.py +24 -0
- samsara/types/v_1_vision_run_by_camera_response.py +35 -0
- samsara/types/v_1_vision_run_by_camera_response_inspection_results.py +26 -0
- samsara/types/v_1_vision_run_by_camera_response_program.py +20 -0
- samsara/types/v_1_vision_run_by_camera_response_run_summary.py +24 -0
- samsara/types/v_1_vision_runs_by_camera_and_program_response.py +30 -0
- samsara/types/v_1_vision_runs_by_camera_response.py +7 -0
- samsara/types/v_1_vision_runs_by_camera_response_item.py +29 -0
- samsara/types/v_1_vision_runs_by_camera_response_item_program.py +20 -0
- samsara/types/v_1_vision_runs_by_camera_response_item_report_metadata.py +24 -0
- samsara/types/v_1_vision_runs_response.py +24 -0
- samsara/types/v_1_vision_runs_response_report_metadata.py +51 -0
- samsara/types/v_1_vision_runs_response_vision_runs.py +28 -0
- samsara/types/v_1_vision_step_results.py +7 -0
- samsara/types/v_1_vision_step_results_item.py +68 -0
- samsara/types/v_1_vision_step_results_item_angle_check.py +48 -0
- samsara/types/v_1_vision_step_results_item_angle_check_angle_configured.py +24 -0
- samsara/types/v_1_vision_step_results_item_barcode_item.py +23 -0
- samsara/types/v_1_vision_step_results_item_boolean_logic.py +21 -0
- samsara/types/v_1_vision_step_results_item_boolean_logic_steps_item.py +20 -0
- samsara/types/v_1_vision_step_results_item_caliper.py +85 -0
- samsara/types/v_1_vision_step_results_item_caliper_angle_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_caliper_contrast_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_caliper_filter_polarity.py +7 -0
- samsara/types/v_1_vision_step_results_item_caliper_sharpness_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_caliper_straightness_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_contour.py +47 -0
- samsara/types/v_1_vision_step_results_item_distance.py +87 -0
- samsara/types/v_1_vision_step_results_item_expiration_date.py +23 -0
- samsara/types/v_1_vision_step_results_item_find_copies.py +52 -0
- samsara/types/v_1_vision_step_results_item_find_edge.py +86 -0
- samsara/types/v_1_vision_step_results_item_find_edge_angle_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_find_edge_contrast_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_find_edge_sharpness_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_find_edge_straightness_range.py +24 -0
- samsara/types/v_1_vision_step_results_item_find_shapes.py +23 -0
- samsara/types/v_1_vision_step_results_item_fixture.py +24 -0
- samsara/types/v_1_vision_step_results_item_fixture_coordinates.py +20 -0
- samsara/types/v_1_vision_step_results_item_label_match.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence.py +55 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_blue_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_grayscale_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_green_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_hue_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_red_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_saturation_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_presence_absence_value_range.py +20 -0
- samsara/types/v_1_vision_step_results_item_text_match.py +22 -0
- samsara/types/vehicle_fault_code_details_object_request_body.py +7 -0
- samsara/types/vehicle_fault_code_details_object_response_body.py +7 -0
- samsara/types/vehicle_safety_score_response_body.py +59 -0
- samsara/types/vehicle_stats_decorations.py +9 -0
- samsara/types/vehicle_stats_decorations_fuel_consumed_milliliters.py +20 -0
- samsara/types/vehicle_stats_decorations_idling_duration_milliseconds.py +20 -0
- samsara/types/vehicle_stats_fuel_consumed_milliliters.py +28 -0
- samsara/types/vehicle_stats_fuel_consumed_milliliters_value.py +3 -0
- samsara/types/vehicle_stats_fuel_consumed_milliliters_with_decoration.py +30 -0
- samsara/types/vehicle_stats_idling_duration_milliseconds.py +28 -0
- samsara/types/vehicle_stats_idling_duration_milliseconds_value.py +3 -0
- samsara/types/vehicle_stats_idling_duration_milliseconds_with_decoration.py +30 -0
- samsara/types/vehicle_stats_list_response_data.py +20 -0
- samsara/types/vehicle_stats_response_data.py +8 -0
- samsara/types/vehicle_stats_synthetic_engine_seconds.py +1 -1
- samsara/types/vehicle_summary.py +68 -0
- samsara/types/vehicles_lock_lock_vehicle_bad_gateway_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_gateway_timeout_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_internal_server_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_method_not_allowed_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_not_found_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_not_implemented_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_service_unavailable_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_too_many_requests_error_response_body.py +33 -0
- samsara/types/vehicles_lock_lock_vehicle_unauthorized_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_bad_gateway_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_gateway_timeout_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_internal_server_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_method_not_allowed_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_not_found_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_not_implemented_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_service_unavailable_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_too_many_requests_error_response_body.py +33 -0
- samsara/types/vehicles_lock_unlock_vehicle_unauthorized_error_response_body.py +33 -0
- samsara/types/webhook_response_response_body_event_types_item.py +2 -0
- samsara/types/webhooks_get_webhook_response_body_event_types_item.py +2 -0
- samsara/types/webhooks_patch_webhook_response_body_event_types_item.py +2 -0
- samsara/types/webhooks_post_webhooks_response_body_event_types_item.py +2 -0
- samsara/types/work_order_object_response_body.py +21 -0
- samsara/types/work_order_tax_create_object_request_body.py +33 -0
- samsara/types/workflow_incident_details_object_response_body.py +4 -0
- samsara/users/__init__.py +28 -1
- samsara/users/client.py +147 -51
- samsara/users/raw_client.py +138 -61
- samsara/users/types/__init__.py +32 -2
- samsara/vehicle_locations/client.py +485 -0
- samsara/vehicle_locations/raw_client.py +472 -0
- samsara/vehicle_stats/__init__.py +52 -0
- samsara/vehicle_stats/client.py +1092 -0
- samsara/vehicle_stats/raw_client.py +1091 -0
- samsara/vehicle_stats/types/__init__.py +50 -0
- samsara/vehicle_stats/types/get_vehicle_stats_feed_request_decorations_item.py +57 -0
- samsara/vehicle_stats/types/get_vehicle_stats_feed_request_types_item.py +71 -0
- samsara/vehicle_stats/types/get_vehicle_stats_history_request_decorations_item.py +57 -0
- samsara/vehicle_stats/types/get_vehicle_stats_history_request_types_item.py +71 -0
- samsara/vehicle_stats/types/get_vehicle_stats_request_types_item.py +71 -0
- samsara/vehicles/__init__.py +58 -32
- samsara/vehicles/client.py +20 -17
- samsara/vehicles/raw_client.py +2 -2
- samsara/vehicles/types/__init__.py +56 -14
- samsara/webhooks/__init__.py +36 -5
- samsara/webhooks/client.py +47 -47
- samsara/webhooks/raw_client.py +18 -51
- samsara/webhooks/types/__init__.py +34 -3
- samsara/webhooks/types/webhooks_post_webhooks_request_body_event_types_item.py +2 -0
- samsara/work_orders/__init__.py +55 -0
- samsara/work_orders/client.py +995 -0
- samsara/work_orders/raw_client.py +2258 -0
- samsara/work_orders/types/__init__.py +53 -0
- samsara/work_orders/types/stream_work_orders_request_work_order_statuses_item.py +18 -0
- samsara_api-4.0.1.dist-info/METADATA +670 -0
- samsara_api-4.0.1.dist-info/RECORD +3387 -0
- samsara/alerts/configurations/__init__.py +0 -7
- samsara/alerts/configurations/client.py +0 -720
- samsara/alerts/configurations/raw_client.py +0 -1552
- samsara/alerts/configurations/types/__init__.py +0 -7
- samsara/alerts/configurations/types/configurations_list_request_status.py +0 -5
- samsara/alerts/incidents/client.py +0 -180
- samsara/alerts/incidents/raw_client.py +0 -396
- samsara/assets/location_and_speed/client.py +0 -226
- samsara/assets/location_and_speed/raw_client.py +0 -458
- samsara/attributes/types/attributes_delete_request_entity_type.py +0 -5
- samsara/attributes/types/attributes_get_request_entity_type.py +0 -5
- samsara/attributes/types/attributes_list_request_entity_type.py +0 -5
- samsara/attributes/types/create_attribute_request_attribute_value_quantity.py +0 -5
- samsara/attributes/types/update_attribute_request_attribute_value_quantity.py +0 -5
- samsara/auth/__init__.py +0 -8
- samsara/auth/client.py +0 -39
- samsara/auth/raw_client.py +0 -13
- samsara/auth/tokens/__init__.py +0 -7
- samsara/auth/tokens/client.py +0 -185
- samsara/auth/tokens/raw_client.py +0 -210
- samsara/auth/tokens/types/__init__.py +0 -7
- samsara/auth/tokens/types/create_tokens_response.py +0 -23
- samsara/cameras/__init__.py +0 -13
- samsara/cameras/client.py +0 -39
- samsara/cameras/media/__init__.py +0 -19
- samsara/cameras/media/client.py +0 -232
- samsara/cameras/media/raw_client.py +0 -417
- samsara/cameras/media/retrieval/__init__.py +0 -13
- samsara/cameras/media/retrieval/client.py +0 -286
- samsara/cameras/media/retrieval/raw_client.py +0 -686
- samsara/cameras/media/retrieval/types/__init__.py +0 -15
- samsara/cameras/media/retrieval/types/media_retrieval_post_media_retrieval_request_body_inputs_item.py +0 -7
- samsara/cameras/media/types/__init__.py +0 -9
- samsara/cameras/media/types/media_list_request_inputs_item.py +0 -7
- samsara/cameras/media/types/media_list_request_media_types_item.py +0 -5
- samsara/cameras/media/types/media_list_request_trigger_reasons_item.py +0 -17
- samsara/cameras/raw_client.py +0 -13
- samsara/coaching/driver_coach_assignments/client.py +0 -285
- samsara/coaching/driver_coach_assignments/raw_client.py +0 -716
- samsara/coaching/sessions/client.py +0 -228
- samsara/coaching/sessions/raw_client.py +0 -448
- samsara/defect_types/client.py +0 -156
- samsara/defect_types/raw_client.py +0 -384
- samsara/defects/client.py +0 -583
- samsara/defects/raw_client.py +0 -1028
- samsara/devices/client.py +0 -190
- samsara/devices/raw_client.py +0 -412
- samsara/document_types/client.py +0 -134
- samsara/document_types/raw_client.py +0 -354
- samsara/documents/pdfs/client.py +0 -206
- samsara/documents/pdfs/raw_client.py +0 -212
- samsara/driver_trailer_assignments/client.py +0 -389
- samsara/driver_trailer_assignments/raw_client.py +0 -1044
- samsara/driver_vehicle_assignments/types/driver_vehicle_assignments_get_request_assignment_type.py +0 -10
- samsara/driver_vehicle_assignments/types/driver_vehicle_assignments_get_request_filter_by.py +0 -5
- samsara/drivers/qr_codes/client.py +0 -304
- samsara/drivers/qr_codes/raw_client.py +0 -926
- samsara/drivers/vehicle_assignments/__init__.py +0 -7
- samsara/drivers/vehicle_assignments/client.py +0 -201
- samsara/drivers/vehicle_assignments/raw_client.py +0 -397
- samsara/drivers/vehicle_assignments/types/__init__.py +0 -9
- samsara/drivers/vehicle_assignments/types/vehicle_assignments_list_request_driver_activation_status.py +0 -5
- samsara/dvirs/__init__.py +0 -7
- samsara/dvirs/client.py +0 -775
- samsara/dvirs/raw_client.py +0 -1223
- samsara/dvirs/types/__init__.py +0 -7
- samsara/equipment/locations/client.py +0 -467
- samsara/equipment/locations/raw_client.py +0 -543
- samsara/equipment/stats/__init__.py +0 -7
- samsara/equipment/stats/client.py +0 -602
- samsara/equipment/stats/raw_client.py +0 -684
- samsara/equipment/stats/types/__init__.py +0 -9
- samsara/equipment/stats/types/stats_feed_request_types_item.py +0 -19
- samsara/equipment/stats/types/stats_history_request_types_item.py +0 -19
- samsara/equipment/stats/types/stats_list_request_types_item.py +0 -19
- samsara/form_submissions/__init__.py +0 -8
- samsara/form_submissions/client.py +0 -669
- samsara/form_submissions/pdf_exports/client.py +0 -221
- samsara/form_submissions/pdf_exports/raw_client.py +0 -627
- samsara/form_submissions/raw_client.py +0 -1550
- samsara/form_submissions/types/__init__.py +0 -9
- samsara/fuel_purchases/__init__.py +0 -7
- samsara/fuel_purchases/client.py +0 -219
- samsara/fuel_purchases/raw_client.py +0 -410
- samsara/fuel_purchases/types/__init__.py +0 -9
- samsara/hos/__init__.py +0 -7
- samsara/hos/client.py +0 -695
- samsara/hos/raw_client.py +0 -1177
- samsara/hos/types/__init__.py +0 -7
- samsara/hos/types/hos_daily_logs_request_driver_activation_status.py +0 -5
- samsara/idling/types/idling_list_request_pto_state.py +0 -5
- samsara/ifta/csv/__init__.py +0 -4
- samsara/ifta/csv/client.py +0 -274
- samsara/ifta/csv/raw_client.py +0 -675
- samsara/inputs/__init__.py +0 -7
- samsara/inputs/client.py +0 -223
- samsara/inputs/raw_client.py +0 -445
- samsara/inputs/types/__init__.py +0 -7
- samsara/inputs/types/inputs_stream_request_type.py +0 -27
- samsara/live_shares/__init__.py +0 -7
- samsara/live_shares/client.py +0 -544
- samsara/live_shares/raw_client.py +0 -1418
- samsara/live_shares/types/__init__.py +0 -10
- samsara/live_shares/types/live_shares_list_request_type.py +0 -7
- samsara/maintenance/service_tasks/__init__.py +0 -4
- samsara/maintenance/service_tasks/client.py +0 -322
- samsara/maintenance/service_tasks/raw_client.py +0 -529
- samsara/maintenance/work_orders/__init__.py +0 -21
- samsara/maintenance/work_orders/client.py +0 -867
- samsara/maintenance/work_orders/raw_client.py +0 -1980
- samsara/maintenance/work_orders/types/__init__.py +0 -19
- samsara/maintenance/work_orders/types/work_orders_stream_request_work_order_statuses_item.py +0 -18
- samsara/me/__init__.py +0 -4
- samsara/me/client.py +0 -108
- samsara/me/raw_client.py +0 -99
- samsara/readings/__init__.py +0 -4
- samsara/readings/client.py +0 -524
- samsara/readings/raw_client.py +0 -1214
- samsara/reports/__init__.py +0 -7
- samsara/reports/client.py +0 -49
- samsara/reports/drivers/__init__.py +0 -7
- samsara/reports/drivers/client.py +0 -39
- samsara/reports/drivers/fuel_energy/__init__.py +0 -4
- samsara/reports/drivers/fuel_energy/client.py +0 -194
- samsara/reports/drivers/fuel_energy/raw_client.py +0 -384
- samsara/reports/drivers/raw_client.py +0 -13
- samsara/reports/ifta/__init__.py +0 -18
- samsara/reports/ifta/client.py +0 -44
- samsara/reports/ifta/jurisdiction/__init__.py +0 -7
- samsara/reports/ifta/jurisdiction/client.py +0 -217
- samsara/reports/ifta/jurisdiction/raw_client.py +0 -409
- samsara/reports/ifta/jurisdiction/types/__init__.py +0 -9
- samsara/reports/ifta/jurisdiction/types/jurisdiction_get_request_fuel_type.py +0 -25
- samsara/reports/ifta/jurisdiction/types/jurisdiction_get_request_month.py +0 -21
- samsara/reports/ifta/jurisdiction/types/jurisdiction_get_request_quarter.py +0 -5
- samsara/reports/ifta/raw_client.py +0 -13
- samsara/reports/ifta/vehicle/__init__.py +0 -7
- samsara/reports/ifta/vehicle/client.py +0 -227
- samsara/reports/ifta/vehicle/raw_client.py +0 -419
- samsara/reports/ifta/vehicle/types/__init__.py +0 -9
- samsara/reports/ifta/vehicle/types/vehicle_list_request_fuel_type.py +0 -25
- samsara/reports/ifta/vehicle/types/vehicle_list_request_month.py +0 -21
- samsara/reports/ifta/vehicle/types/vehicle_list_request_quarter.py +0 -5
- samsara/reports/raw_client.py +0 -13
- samsara/reports/vehicles/__init__.py +0 -8
- samsara/reports/vehicles/client.py +0 -44
- samsara/reports/vehicles/fuel_energy/__init__.py +0 -7
- samsara/reports/vehicles/fuel_energy/client.py +0 -205
- samsara/reports/vehicles/fuel_energy/raw_client.py +0 -395
- samsara/reports/vehicles/fuel_energy/types/__init__.py +0 -7
- samsara/reports/vehicles/fuel_energy/types/fuel_energy_list_request_energy_type.py +0 -5
- samsara/reports/vehicles/idling/__init__.py +0 -4
- samsara/reports/vehicles/idling/client.py +0 -236
- samsara/reports/vehicles/idling/raw_client.py +0 -462
- samsara/reports/vehicles/raw_client.py +0 -13
- samsara/routes/audit_logs/__init__.py +0 -4
- samsara/routes/audit_logs/client.py +0 -146
- samsara/routes/audit_logs/raw_client.py +0 -350
- samsara/safety_events/__init__.py +0 -7
- samsara/safety_events/audit_logs/__init__.py +0 -4
- samsara/safety_events/audit_logs/client.py +0 -160
- samsara/safety_events/audit_logs/raw_client.py +0 -386
- samsara/safety_events/client.py +0 -199
- samsara/safety_events/raw_client.py +0 -207
- samsara/settings/compliance/__init__.py +0 -4
- samsara/settings/compliance/client.py +0 -308
- samsara/settings/compliance/raw_client.py +0 -718
- samsara/settings/driver_app/__init__.py +0 -4
- samsara/settings/driver_app/client.py +0 -270
- samsara/settings/driver_app/raw_client.py +0 -697
- samsara/settings/safety/__init__.py +0 -4
- samsara/settings/safety/client.py +0 -118
- samsara/settings/safety/raw_client.py +0 -314
- samsara/speeding_intervals/types/speeding_intervals_stream_request_query_by.py +0 -5
- samsara/tachograph/__init__.py +0 -7
- samsara/tachograph/client.py +0 -44
- samsara/tachograph/driver/__init__.py +0 -4
- samsara/tachograph/driver/client.py +0 -337
- samsara/tachograph/driver/raw_client.py +0 -322
- samsara/tachograph/raw_client.py +0 -13
- samsara/tachograph/vehicles/__init__.py +0 -4
- samsara/tachograph/vehicles/client.py +0 -190
- samsara/tachograph/vehicles/raw_client.py +0 -173
- samsara/training_assignments/__init__.py +0 -4
- samsara/training_assignments/client.py +0 -520
- samsara/training_assignments/raw_client.py +0 -1326
- samsara/training_courses/__init__.py +0 -4
- samsara/training_courses/client.py +0 -178
- samsara/training_courses/raw_client.py +0 -398
- samsara/trips/types/__init__.py +0 -8
- samsara/trips/types/trips_stream_request_completion_status.py +0 -5
- samsara/trips/types/trips_stream_request_query_by.py +0 -5
- samsara/types/alert_event.py +0 -74
- samsara/types/alert_event_alert_condition_id.py +0 -40
- samsara/types/alert_event_device.py +0 -37
- samsara/types/alert_event_driver.py +0 -27
- samsara/types/alert_event_dvir.py +0 -52
- samsara/types/alert_event_dvir_defects_item.py +0 -44
- samsara/types/alert_event_dvir_driver.py +0 -27
- samsara/types/alert_event_dvir_inspection_type.py +0 -7
- samsara/types/alert_event_dvir_safety_status.py +0 -5
- samsara/types/alert_event_dvir_trailer.py +0 -27
- samsara/types/alert_event_dvir_vehicle.py +0 -27
- samsara/types/assets_location_link_config_object.py +0 -31
- samsara/types/assets_location_link_config_object_response_body.py +0 -33
- samsara/types/attribute_attribute_value_quantity.py +0 -5
- samsara/types/external_ids.py +0 -5
- samsara/types/webhook_event.py +0 -37
- samsara/user_roles/__init__.py +0 -4
- samsara/user_roles/client.py +0 -142
- samsara/user_roles/raw_client.py +0 -159
- samsara/v_1_messages/__init__.py +0 -4
- samsara/v_1_messages/client.py +0 -258
- samsara/v_1_messages/raw_client.py +0 -273
- samsara/vehicles/immobilizer/__init__.py +0 -4
- samsara/vehicles/immobilizer/client.py +0 -182
- samsara/vehicles/immobilizer/raw_client.py +0 -398
- samsara/vehicles/locations/__init__.py +0 -4
- samsara/vehicles/locations/client.py +0 -501
- samsara/vehicles/locations/raw_client.py +0 -579
- samsara/vehicles/stats/__init__.py +0 -19
- samsara/vehicles/stats/client.py +0 -1076
- samsara/vehicles/stats/raw_client.py +0 -1164
- samsara/vehicles/stats/types/__init__.py +0 -17
- samsara/vehicles/stats/types/stats_feed_request_decorations_item.py +0 -54
- samsara/vehicles/stats/types/stats_feed_request_types_item.py +0 -68
- samsara/vehicles/stats/types/stats_history_request_decorations_item.py +0 -54
- samsara/vehicles/stats/types/stats_history_request_types_item.py +0 -68
- samsara/vehicles/stats/types/stats_list_request_types_item.py +0 -68
- samsara_api-3.0.0.dist-info/METADATA +0 -238
- samsara_api-3.0.0.dist-info/RECORD +0 -2664
- /samsara/{alerts/incidents → driver_qr_codes}/__init__.py +0 -0
- /samsara/{assets/location_and_speed → fleet/attributes}/__init__.py +0 -0
- /samsara/{form_submissions → forms}/types/form_submissions_patch_form_submission_request_body_status.py +0 -0
- /samsara/{fuel_purchases → fuel_and_energy}/types/fuel_purchase_post_fuel_purchase_request_body_ifta_fuel_type.py +0 -0
- /samsara/{coaching/driver_coach_assignments → hubs}/__init__.py +0 -0
- /samsara/{coaching/sessions → industrial}/__init__.py +0 -0
- /samsara/{live_shares → live_sharing_links}/types/live_sharing_links_create_live_sharing_link_request_body_type.py +0 -0
- /samsara/{defect_types → location_and_speed}/__init__.py +0 -0
- /samsara/{dvirs → maintenance}/types/create_dvir_request_safety_status.py +0 -0
- /samsara/{cameras/media/retrieval → media}/types/media_retrieval_post_media_retrieval_request_body_media_type.py +0 -0
- /samsara/{defects → messages}/__init__.py +0 -0
- /samsara/{devices → organization_info}/__init__.py +0 -0
- /samsara/{document_types → plans}/__init__.py +0 -0
- /samsara/{documents/pdfs → preview_ap_is}/__init__.py +0 -0
- /samsara/{driver_trailer_assignments → safety}/__init__.py +0 -0
- /samsara/{drivers/qr_codes → tachograph_eu_only}/__init__.py +0 -0
- /samsara/{equipment/locations → trailer_assignments}/__init__.py +0 -0
- /samsara/{form_submissions/pdf_exports → vehicle_locations}/__init__.py +0 -0
- /samsara/{maintenance/work_orders → work_orders}/types/work_orders_patch_work_orders_request_body_category.py +0 -0
- /samsara/{maintenance/work_orders → work_orders}/types/work_orders_patch_work_orders_request_body_priority.py +0 -0
- /samsara/{maintenance/work_orders → work_orders}/types/work_orders_patch_work_orders_request_body_status.py +0 -0
- /samsara/{maintenance/work_orders → work_orders}/types/work_orders_post_work_orders_request_body_category.py +0 -0
- /samsara/{maintenance/work_orders → work_orders}/types/work_orders_post_work_orders_request_body_priority.py +0 -0
- {samsara_api-3.0.0.dist-info → samsara_api-4.0.1.dist-info}/LICENSE +0 -0
- {samsara_api-3.0.0.dist-info → samsara_api-4.0.1.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,2167 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
import typing
|
|
4
|
+
|
|
5
|
+
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
|
|
6
|
+
from ..core.request_options import RequestOptions
|
|
7
|
+
from ..types.asset_data_outputs_patch_asset_data_outputs_response_body import (
|
|
8
|
+
AssetDataOutputsPatchAssetDataOutputsResponseBody,
|
|
9
|
+
)
|
|
10
|
+
from ..types.asset_location import AssetLocation
|
|
11
|
+
from ..types.asset_name import AssetName
|
|
12
|
+
from ..types.custom_metadata import CustomMetadata
|
|
13
|
+
from ..types.data_input_list_response import DataInputListResponse
|
|
14
|
+
from ..types.data_input_snapshot_response import DataInputSnapshotResponse
|
|
15
|
+
from ..types.data_inputs_tiny_response import DataInputsTinyResponse
|
|
16
|
+
from ..types.inline_response_200 import InlineResponse200
|
|
17
|
+
from ..types.inline_response_2008 import InlineResponse2008
|
|
18
|
+
from ..types.list_industrial_assets_response import ListIndustrialAssetsResponse
|
|
19
|
+
from ..types.location_type import LocationType
|
|
20
|
+
from ..types.parent_id import ParentId
|
|
21
|
+
from ..types.standard_delete_response import StandardDeleteResponse
|
|
22
|
+
from ..types.tag_ids import TagIds
|
|
23
|
+
from ..types.v_1_machine_history_response import V1MachineHistoryResponse
|
|
24
|
+
from ..types.v_1_programs_for_the_camera_response import V1ProgramsForTheCameraResponse
|
|
25
|
+
from ..types.v_1_vision_cameras_response import V1VisionCamerasResponse
|
|
26
|
+
from ..types.v_1_vision_run_by_camera_response import V1VisionRunByCameraResponse
|
|
27
|
+
from ..types.v_1_vision_runs_by_camera_and_program_response import V1VisionRunsByCameraAndProgramResponse
|
|
28
|
+
from ..types.v_1_vision_runs_by_camera_response import V1VisionRunsByCameraResponse
|
|
29
|
+
from ..types.v_1_vision_runs_response import V1VisionRunsResponse
|
|
30
|
+
from .raw_client import AsyncRawIndustrialClient, RawIndustrialClient
|
|
31
|
+
|
|
32
|
+
# this is used as the default value for optional parameters
|
|
33
|
+
OMIT = typing.cast(typing.Any, ...)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class IndustrialClient:
|
|
37
|
+
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
|
38
|
+
self._raw_client = RawIndustrialClient(client_wrapper=client_wrapper)
|
|
39
|
+
|
|
40
|
+
@property
|
|
41
|
+
def with_raw_response(self) -> RawIndustrialClient:
|
|
42
|
+
"""
|
|
43
|
+
Retrieves a raw implementation of this client that returns raw responses.
|
|
44
|
+
|
|
45
|
+
Returns
|
|
46
|
+
-------
|
|
47
|
+
RawIndustrialClient
|
|
48
|
+
"""
|
|
49
|
+
return self._raw_client
|
|
50
|
+
|
|
51
|
+
def get_industrial_assets(
|
|
52
|
+
self,
|
|
53
|
+
*,
|
|
54
|
+
limit: typing.Optional[int] = None,
|
|
55
|
+
after: typing.Optional[str] = None,
|
|
56
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
57
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
58
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
59
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
60
|
+
) -> ListIndustrialAssetsResponse:
|
|
61
|
+
"""
|
|
62
|
+
List all assets in the organization.
|
|
63
|
+
|
|
64
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
65
|
+
|
|
66
|
+
To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
67
|
+
|
|
68
|
+
Parameters
|
|
69
|
+
----------
|
|
70
|
+
limit : typing.Optional[int]
|
|
71
|
+
The limit for how many objects will be in the response. Default and max for this value is 512 objects.
|
|
72
|
+
|
|
73
|
+
after : typing.Optional[str]
|
|
74
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
75
|
+
|
|
76
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
77
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
78
|
+
|
|
79
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
80
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
81
|
+
|
|
82
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
83
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
84
|
+
|
|
85
|
+
request_options : typing.Optional[RequestOptions]
|
|
86
|
+
Request-specific configuration.
|
|
87
|
+
|
|
88
|
+
Returns
|
|
89
|
+
-------
|
|
90
|
+
ListIndustrialAssetsResponse
|
|
91
|
+
Assets in the organization.
|
|
92
|
+
|
|
93
|
+
Examples
|
|
94
|
+
--------
|
|
95
|
+
from samsara import Samsara
|
|
96
|
+
|
|
97
|
+
client = Samsara(
|
|
98
|
+
token="YOUR_TOKEN",
|
|
99
|
+
)
|
|
100
|
+
client.industrial.get_industrial_assets(
|
|
101
|
+
limit=1000000,
|
|
102
|
+
after="after",
|
|
103
|
+
)
|
|
104
|
+
"""
|
|
105
|
+
_response = self._raw_client.get_industrial_assets(
|
|
106
|
+
limit=limit,
|
|
107
|
+
after=after,
|
|
108
|
+
parent_tag_ids=parent_tag_ids,
|
|
109
|
+
tag_ids=tag_ids,
|
|
110
|
+
asset_ids=asset_ids,
|
|
111
|
+
request_options=request_options,
|
|
112
|
+
)
|
|
113
|
+
return _response.data
|
|
114
|
+
|
|
115
|
+
def create_industrial_asset(
|
|
116
|
+
self,
|
|
117
|
+
*,
|
|
118
|
+
name: AssetName,
|
|
119
|
+
custom_metadata: typing.Optional[CustomMetadata] = OMIT,
|
|
120
|
+
location: typing.Optional[AssetLocation] = OMIT,
|
|
121
|
+
location_data_input_id: typing.Optional[str] = OMIT,
|
|
122
|
+
location_type: typing.Optional[LocationType] = OMIT,
|
|
123
|
+
parent_id: typing.Optional[ParentId] = OMIT,
|
|
124
|
+
running_status_data_input_id: typing.Optional[str] = OMIT,
|
|
125
|
+
tag_ids: typing.Optional[TagIds] = OMIT,
|
|
126
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
127
|
+
) -> InlineResponse200:
|
|
128
|
+
"""
|
|
129
|
+
Create an asset with optional configuration parameters.
|
|
130
|
+
|
|
131
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
132
|
+
|
|
133
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
134
|
+
|
|
135
|
+
Parameters
|
|
136
|
+
----------
|
|
137
|
+
name : AssetName
|
|
138
|
+
|
|
139
|
+
custom_metadata : typing.Optional[CustomMetadata]
|
|
140
|
+
|
|
141
|
+
location : typing.Optional[AssetLocation]
|
|
142
|
+
|
|
143
|
+
location_data_input_id : typing.Optional[str]
|
|
144
|
+
Required if locationType is "dataInput". Specifies the id of a location data input which will determine the asset's location. **The data input will be moved to the new asset.**
|
|
145
|
+
|
|
146
|
+
location_type : typing.Optional[LocationType]
|
|
147
|
+
|
|
148
|
+
parent_id : typing.Optional[ParentId]
|
|
149
|
+
|
|
150
|
+
running_status_data_input_id : typing.Optional[str]
|
|
151
|
+
The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. **The data input will be moved to the new asset.**
|
|
152
|
+
|
|
153
|
+
tag_ids : typing.Optional[TagIds]
|
|
154
|
+
|
|
155
|
+
request_options : typing.Optional[RequestOptions]
|
|
156
|
+
Request-specific configuration.
|
|
157
|
+
|
|
158
|
+
Returns
|
|
159
|
+
-------
|
|
160
|
+
InlineResponse200
|
|
161
|
+
Newly created asset object
|
|
162
|
+
|
|
163
|
+
Examples
|
|
164
|
+
--------
|
|
165
|
+
from samsara import Samsara
|
|
166
|
+
|
|
167
|
+
client = Samsara(
|
|
168
|
+
token="YOUR_TOKEN",
|
|
169
|
+
)
|
|
170
|
+
client.industrial.create_industrial_asset(
|
|
171
|
+
name="name",
|
|
172
|
+
)
|
|
173
|
+
"""
|
|
174
|
+
_response = self._raw_client.create_industrial_asset(
|
|
175
|
+
name=name,
|
|
176
|
+
custom_metadata=custom_metadata,
|
|
177
|
+
location=location,
|
|
178
|
+
location_data_input_id=location_data_input_id,
|
|
179
|
+
location_type=location_type,
|
|
180
|
+
parent_id=parent_id,
|
|
181
|
+
running_status_data_input_id=running_status_data_input_id,
|
|
182
|
+
tag_ids=tag_ids,
|
|
183
|
+
request_options=request_options,
|
|
184
|
+
)
|
|
185
|
+
return _response.data
|
|
186
|
+
|
|
187
|
+
def delete_industrial_asset(
|
|
188
|
+
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
189
|
+
) -> StandardDeleteResponse:
|
|
190
|
+
"""
|
|
191
|
+
Delete asset.
|
|
192
|
+
|
|
193
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
194
|
+
|
|
195
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
196
|
+
|
|
197
|
+
Parameters
|
|
198
|
+
----------
|
|
199
|
+
id : str
|
|
200
|
+
Id of the asset to be deleted.
|
|
201
|
+
|
|
202
|
+
request_options : typing.Optional[RequestOptions]
|
|
203
|
+
Request-specific configuration.
|
|
204
|
+
|
|
205
|
+
Returns
|
|
206
|
+
-------
|
|
207
|
+
StandardDeleteResponse
|
|
208
|
+
A successful DELETE response is a 204 with no content.
|
|
209
|
+
|
|
210
|
+
Examples
|
|
211
|
+
--------
|
|
212
|
+
from samsara import Samsara
|
|
213
|
+
|
|
214
|
+
client = Samsara(
|
|
215
|
+
token="YOUR_TOKEN",
|
|
216
|
+
)
|
|
217
|
+
client.industrial.delete_industrial_asset(
|
|
218
|
+
id="id",
|
|
219
|
+
)
|
|
220
|
+
"""
|
|
221
|
+
_response = self._raw_client.delete_industrial_asset(id, request_options=request_options)
|
|
222
|
+
return _response.data
|
|
223
|
+
|
|
224
|
+
def patch_industrial_asset(
|
|
225
|
+
self,
|
|
226
|
+
id: str,
|
|
227
|
+
*,
|
|
228
|
+
custom_metadata: typing.Optional[CustomMetadata] = OMIT,
|
|
229
|
+
location: typing.Optional[AssetLocation] = OMIT,
|
|
230
|
+
location_data_input_id: typing.Optional[str] = OMIT,
|
|
231
|
+
location_type: typing.Optional[LocationType] = OMIT,
|
|
232
|
+
name: typing.Optional[AssetName] = OMIT,
|
|
233
|
+
parent_id: typing.Optional[str] = OMIT,
|
|
234
|
+
running_status_data_input_id: typing.Optional[str] = OMIT,
|
|
235
|
+
tag_ids: typing.Optional[TagIds] = OMIT,
|
|
236
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
237
|
+
) -> InlineResponse200:
|
|
238
|
+
"""
|
|
239
|
+
Update an existing asset. Only the provided fields will be updated.
|
|
240
|
+
|
|
241
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
242
|
+
|
|
243
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
244
|
+
|
|
245
|
+
Parameters
|
|
246
|
+
----------
|
|
247
|
+
id : str
|
|
248
|
+
Id of the asset to be updated
|
|
249
|
+
|
|
250
|
+
custom_metadata : typing.Optional[CustomMetadata]
|
|
251
|
+
|
|
252
|
+
location : typing.Optional[AssetLocation]
|
|
253
|
+
|
|
254
|
+
location_data_input_id : typing.Optional[str]
|
|
255
|
+
Required if locationType is "dataInput". Specifies the id of a location data input which will determine the asset's location. The data input must be in the asset.
|
|
256
|
+
|
|
257
|
+
location_type : typing.Optional[LocationType]
|
|
258
|
+
|
|
259
|
+
name : typing.Optional[AssetName]
|
|
260
|
+
|
|
261
|
+
parent_id : typing.Optional[str]
|
|
262
|
+
The id of the parent asset that the asset belongs to. Pass in an empty string to remove the child from the parent.
|
|
263
|
+
|
|
264
|
+
running_status_data_input_id : typing.Optional[str]
|
|
265
|
+
The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. The data input must be in the asset.
|
|
266
|
+
|
|
267
|
+
tag_ids : typing.Optional[TagIds]
|
|
268
|
+
|
|
269
|
+
request_options : typing.Optional[RequestOptions]
|
|
270
|
+
Request-specific configuration.
|
|
271
|
+
|
|
272
|
+
Returns
|
|
273
|
+
-------
|
|
274
|
+
InlineResponse200
|
|
275
|
+
The updated asset
|
|
276
|
+
|
|
277
|
+
Examples
|
|
278
|
+
--------
|
|
279
|
+
from samsara import Samsara
|
|
280
|
+
|
|
281
|
+
client = Samsara(
|
|
282
|
+
token="YOUR_TOKEN",
|
|
283
|
+
)
|
|
284
|
+
client.industrial.patch_industrial_asset(
|
|
285
|
+
id="id",
|
|
286
|
+
)
|
|
287
|
+
"""
|
|
288
|
+
_response = self._raw_client.patch_industrial_asset(
|
|
289
|
+
id,
|
|
290
|
+
custom_metadata=custom_metadata,
|
|
291
|
+
location=location,
|
|
292
|
+
location_data_input_id=location_data_input_id,
|
|
293
|
+
location_type=location_type,
|
|
294
|
+
name=name,
|
|
295
|
+
parent_id=parent_id,
|
|
296
|
+
running_status_data_input_id=running_status_data_input_id,
|
|
297
|
+
tag_ids=tag_ids,
|
|
298
|
+
request_options=request_options,
|
|
299
|
+
)
|
|
300
|
+
return _response.data
|
|
301
|
+
|
|
302
|
+
def patch_asset_data_outputs(
|
|
303
|
+
self,
|
|
304
|
+
id: str,
|
|
305
|
+
*,
|
|
306
|
+
values: typing.Dict[str, typing.Optional[typing.Any]],
|
|
307
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
308
|
+
) -> AssetDataOutputsPatchAssetDataOutputsResponseBody:
|
|
309
|
+
"""
|
|
310
|
+
Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated.
|
|
311
|
+
|
|
312
|
+
<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
313
|
+
|
|
314
|
+
To use this endpoint, select **Write Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
318
|
+
|
|
319
|
+
Parameters
|
|
320
|
+
----------
|
|
321
|
+
id : str
|
|
322
|
+
Asset ID
|
|
323
|
+
|
|
324
|
+
values : typing.Dict[str, typing.Optional[typing.Any]]
|
|
325
|
+
A map of data output IDs to values. All data outputs must belong to the same asset. Only the specified IDs will be written to.
|
|
326
|
+
|
|
327
|
+
request_options : typing.Optional[RequestOptions]
|
|
328
|
+
Request-specific configuration.
|
|
329
|
+
|
|
330
|
+
Returns
|
|
331
|
+
-------
|
|
332
|
+
AssetDataOutputsPatchAssetDataOutputsResponseBody
|
|
333
|
+
OK response.
|
|
334
|
+
|
|
335
|
+
Examples
|
|
336
|
+
--------
|
|
337
|
+
from samsara import Samsara
|
|
338
|
+
|
|
339
|
+
client = Samsara(
|
|
340
|
+
token="YOUR_TOKEN",
|
|
341
|
+
)
|
|
342
|
+
client.industrial.patch_asset_data_outputs(
|
|
343
|
+
id="id",
|
|
344
|
+
values={"key": "value"},
|
|
345
|
+
)
|
|
346
|
+
"""
|
|
347
|
+
_response = self._raw_client.patch_asset_data_outputs(id, values=values, request_options=request_options)
|
|
348
|
+
return _response.data
|
|
349
|
+
|
|
350
|
+
def get_data_inputs(
|
|
351
|
+
self,
|
|
352
|
+
*,
|
|
353
|
+
limit: typing.Optional[int] = None,
|
|
354
|
+
after: typing.Optional[str] = None,
|
|
355
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
356
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
357
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
358
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
359
|
+
) -> DataInputsTinyResponse:
|
|
360
|
+
"""
|
|
361
|
+
Returns all data inputs, optionally filtered by tags or asset ids.
|
|
362
|
+
|
|
363
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
364
|
+
|
|
365
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
366
|
+
|
|
367
|
+
Parameters
|
|
368
|
+
----------
|
|
369
|
+
limit : typing.Optional[int]
|
|
370
|
+
The limit for how many objects will be in the response. Default and max for this value is 512 objects.
|
|
371
|
+
|
|
372
|
+
after : typing.Optional[str]
|
|
373
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
374
|
+
|
|
375
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
376
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
377
|
+
|
|
378
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
379
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
380
|
+
|
|
381
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
382
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
383
|
+
|
|
384
|
+
request_options : typing.Optional[RequestOptions]
|
|
385
|
+
Request-specific configuration.
|
|
386
|
+
|
|
387
|
+
Returns
|
|
388
|
+
-------
|
|
389
|
+
DataInputsTinyResponse
|
|
390
|
+
List of data inputs with names, ids, and other metadata.
|
|
391
|
+
|
|
392
|
+
Examples
|
|
393
|
+
--------
|
|
394
|
+
from samsara import Samsara
|
|
395
|
+
|
|
396
|
+
client = Samsara(
|
|
397
|
+
token="YOUR_TOKEN",
|
|
398
|
+
)
|
|
399
|
+
client.industrial.get_data_inputs(
|
|
400
|
+
limit=1000000,
|
|
401
|
+
after="after",
|
|
402
|
+
)
|
|
403
|
+
"""
|
|
404
|
+
_response = self._raw_client.get_data_inputs(
|
|
405
|
+
limit=limit,
|
|
406
|
+
after=after,
|
|
407
|
+
parent_tag_ids=parent_tag_ids,
|
|
408
|
+
tag_ids=tag_ids,
|
|
409
|
+
asset_ids=asset_ids,
|
|
410
|
+
request_options=request_options,
|
|
411
|
+
)
|
|
412
|
+
return _response.data
|
|
413
|
+
|
|
414
|
+
def get_data_input_data_snapshot(
|
|
415
|
+
self,
|
|
416
|
+
*,
|
|
417
|
+
after: typing.Optional[str] = None,
|
|
418
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
419
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
420
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
421
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
422
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
423
|
+
) -> DataInputSnapshotResponse:
|
|
424
|
+
"""
|
|
425
|
+
Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs.
|
|
426
|
+
|
|
427
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
428
|
+
|
|
429
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
430
|
+
|
|
431
|
+
Parameters
|
|
432
|
+
----------
|
|
433
|
+
after : typing.Optional[str]
|
|
434
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
435
|
+
|
|
436
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
437
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
438
|
+
|
|
439
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
440
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
441
|
+
|
|
442
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
443
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
444
|
+
|
|
445
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
446
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
447
|
+
|
|
448
|
+
request_options : typing.Optional[RequestOptions]
|
|
449
|
+
Request-specific configuration.
|
|
450
|
+
|
|
451
|
+
Returns
|
|
452
|
+
-------
|
|
453
|
+
DataInputSnapshotResponse
|
|
454
|
+
List of last known data input data points and pagination parameters
|
|
455
|
+
|
|
456
|
+
Examples
|
|
457
|
+
--------
|
|
458
|
+
from samsara import Samsara
|
|
459
|
+
|
|
460
|
+
client = Samsara(
|
|
461
|
+
token="YOUR_TOKEN",
|
|
462
|
+
)
|
|
463
|
+
client.industrial.get_data_input_data_snapshot(
|
|
464
|
+
after="after",
|
|
465
|
+
)
|
|
466
|
+
"""
|
|
467
|
+
_response = self._raw_client.get_data_input_data_snapshot(
|
|
468
|
+
after=after,
|
|
469
|
+
parent_tag_ids=parent_tag_ids,
|
|
470
|
+
tag_ids=tag_ids,
|
|
471
|
+
data_input_ids=data_input_ids,
|
|
472
|
+
asset_ids=asset_ids,
|
|
473
|
+
request_options=request_options,
|
|
474
|
+
)
|
|
475
|
+
return _response.data
|
|
476
|
+
|
|
477
|
+
def get_data_input_data_feed(
|
|
478
|
+
self,
|
|
479
|
+
*,
|
|
480
|
+
after: typing.Optional[str] = None,
|
|
481
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
482
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
483
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
484
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
485
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
486
|
+
) -> DataInputListResponse:
|
|
487
|
+
"""
|
|
488
|
+
Follow a continuous feed of all data input data points.
|
|
489
|
+
|
|
490
|
+
Your first call to this endpoint will provide you with the most recent data points for each data input and a `pagination` object that contains an `endCursor`.
|
|
491
|
+
|
|
492
|
+
You can provide the `endCursor` to the `after` parameter of this endpoint to get data point updates since that `endCursor`.
|
|
493
|
+
|
|
494
|
+
If `hasNextPage` is `false`, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates.
|
|
495
|
+
|
|
496
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
497
|
+
|
|
498
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
499
|
+
|
|
500
|
+
Parameters
|
|
501
|
+
----------
|
|
502
|
+
after : typing.Optional[str]
|
|
503
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
504
|
+
|
|
505
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
506
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
507
|
+
|
|
508
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
509
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
510
|
+
|
|
511
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
512
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
513
|
+
|
|
514
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
515
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
516
|
+
|
|
517
|
+
request_options : typing.Optional[RequestOptions]
|
|
518
|
+
Request-specific configuration.
|
|
519
|
+
|
|
520
|
+
Returns
|
|
521
|
+
-------
|
|
522
|
+
DataInputListResponse
|
|
523
|
+
List of all data points for specified data inputs
|
|
524
|
+
|
|
525
|
+
Examples
|
|
526
|
+
--------
|
|
527
|
+
from samsara import Samsara
|
|
528
|
+
|
|
529
|
+
client = Samsara(
|
|
530
|
+
token="YOUR_TOKEN",
|
|
531
|
+
)
|
|
532
|
+
client.industrial.get_data_input_data_feed(
|
|
533
|
+
after="after",
|
|
534
|
+
)
|
|
535
|
+
"""
|
|
536
|
+
_response = self._raw_client.get_data_input_data_feed(
|
|
537
|
+
after=after,
|
|
538
|
+
parent_tag_ids=parent_tag_ids,
|
|
539
|
+
tag_ids=tag_ids,
|
|
540
|
+
data_input_ids=data_input_ids,
|
|
541
|
+
asset_ids=asset_ids,
|
|
542
|
+
request_options=request_options,
|
|
543
|
+
)
|
|
544
|
+
return _response.data
|
|
545
|
+
|
|
546
|
+
def get_data_input_data_history(
|
|
547
|
+
self,
|
|
548
|
+
*,
|
|
549
|
+
start_time: str,
|
|
550
|
+
end_time: str,
|
|
551
|
+
after: typing.Optional[str] = None,
|
|
552
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
553
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
554
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
555
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
556
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
557
|
+
) -> DataInputListResponse:
|
|
558
|
+
"""
|
|
559
|
+
Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs.
|
|
560
|
+
|
|
561
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
562
|
+
|
|
563
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
564
|
+
|
|
565
|
+
Parameters
|
|
566
|
+
----------
|
|
567
|
+
start_time : str
|
|
568
|
+
A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
|
|
569
|
+
|
|
570
|
+
end_time : str
|
|
571
|
+
An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
|
|
572
|
+
|
|
573
|
+
after : typing.Optional[str]
|
|
574
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
575
|
+
|
|
576
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
577
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
578
|
+
|
|
579
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
580
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
581
|
+
|
|
582
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
583
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
584
|
+
|
|
585
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
586
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
587
|
+
|
|
588
|
+
request_options : typing.Optional[RequestOptions]
|
|
589
|
+
Request-specific configuration.
|
|
590
|
+
|
|
591
|
+
Returns
|
|
592
|
+
-------
|
|
593
|
+
DataInputListResponse
|
|
594
|
+
List of all data points for the specified data inputs and time range.
|
|
595
|
+
|
|
596
|
+
Examples
|
|
597
|
+
--------
|
|
598
|
+
from samsara import Samsara
|
|
599
|
+
|
|
600
|
+
client = Samsara(
|
|
601
|
+
token="YOUR_TOKEN",
|
|
602
|
+
)
|
|
603
|
+
client.industrial.get_data_input_data_history(
|
|
604
|
+
start_time="startTime",
|
|
605
|
+
end_time="endTime",
|
|
606
|
+
after="after",
|
|
607
|
+
)
|
|
608
|
+
"""
|
|
609
|
+
_response = self._raw_client.get_data_input_data_history(
|
|
610
|
+
start_time=start_time,
|
|
611
|
+
end_time=end_time,
|
|
612
|
+
after=after,
|
|
613
|
+
parent_tag_ids=parent_tag_ids,
|
|
614
|
+
tag_ids=tag_ids,
|
|
615
|
+
data_input_ids=data_input_ids,
|
|
616
|
+
asset_ids=asset_ids,
|
|
617
|
+
request_options=request_options,
|
|
618
|
+
)
|
|
619
|
+
return _response.data
|
|
620
|
+
|
|
621
|
+
def v_1_get_cameras(self, *, request_options: typing.Optional[RequestOptions] = None) -> V1VisionCamerasResponse:
|
|
622
|
+
"""
|
|
623
|
+
<n class="warning">
|
|
624
|
+
<nh>
|
|
625
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
626
|
+
This endpoint is still on our legacy API.
|
|
627
|
+
</nh>
|
|
628
|
+
</n>
|
|
629
|
+
|
|
630
|
+
Fetch all cameras.
|
|
631
|
+
|
|
632
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
633
|
+
|
|
634
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
635
|
+
|
|
636
|
+
Parameters
|
|
637
|
+
----------
|
|
638
|
+
request_options : typing.Optional[RequestOptions]
|
|
639
|
+
Request-specific configuration.
|
|
640
|
+
|
|
641
|
+
Returns
|
|
642
|
+
-------
|
|
643
|
+
V1VisionCamerasResponse
|
|
644
|
+
Returns details about a camera.
|
|
645
|
+
|
|
646
|
+
Examples
|
|
647
|
+
--------
|
|
648
|
+
from samsara import Samsara
|
|
649
|
+
|
|
650
|
+
client = Samsara(
|
|
651
|
+
token="YOUR_TOKEN",
|
|
652
|
+
)
|
|
653
|
+
client.industrial.v_1_get_cameras()
|
|
654
|
+
"""
|
|
655
|
+
_response = self._raw_client.v_1_get_cameras(request_options=request_options)
|
|
656
|
+
return _response.data
|
|
657
|
+
|
|
658
|
+
def v_1_get_vision_programs_by_camera(
|
|
659
|
+
self, camera_id: int, *, request_options: typing.Optional[RequestOptions] = None
|
|
660
|
+
) -> V1ProgramsForTheCameraResponse:
|
|
661
|
+
"""
|
|
662
|
+
<n class="warning">
|
|
663
|
+
<nh>
|
|
664
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
665
|
+
This endpoint is still on our legacy API.
|
|
666
|
+
</nh>
|
|
667
|
+
</n>
|
|
668
|
+
|
|
669
|
+
Fetch configured programs on the camera.
|
|
670
|
+
|
|
671
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
672
|
+
|
|
673
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
674
|
+
|
|
675
|
+
Parameters
|
|
676
|
+
----------
|
|
677
|
+
camera_id : int
|
|
678
|
+
The camera_id should be valid for the given accessToken.
|
|
679
|
+
|
|
680
|
+
request_options : typing.Optional[RequestOptions]
|
|
681
|
+
Request-specific configuration.
|
|
682
|
+
|
|
683
|
+
Returns
|
|
684
|
+
-------
|
|
685
|
+
V1ProgramsForTheCameraResponse
|
|
686
|
+
Returns programs configured on the camera.
|
|
687
|
+
|
|
688
|
+
Examples
|
|
689
|
+
--------
|
|
690
|
+
from samsara import Samsara
|
|
691
|
+
|
|
692
|
+
client = Samsara(
|
|
693
|
+
token="YOUR_TOKEN",
|
|
694
|
+
)
|
|
695
|
+
client.industrial.v_1_get_vision_programs_by_camera(
|
|
696
|
+
camera_id=1000000,
|
|
697
|
+
)
|
|
698
|
+
"""
|
|
699
|
+
_response = self._raw_client.v_1_get_vision_programs_by_camera(camera_id, request_options=request_options)
|
|
700
|
+
return _response.data
|
|
701
|
+
|
|
702
|
+
def v_1_get_vision_latest_run_camera(
|
|
703
|
+
self,
|
|
704
|
+
camera_id: int,
|
|
705
|
+
*,
|
|
706
|
+
program_id: typing.Optional[int] = None,
|
|
707
|
+
started_at_ms: typing.Optional[int] = None,
|
|
708
|
+
include: typing.Optional[str] = None,
|
|
709
|
+
limit: typing.Optional[int] = None,
|
|
710
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
711
|
+
) -> V1VisionRunByCameraResponse:
|
|
712
|
+
"""
|
|
713
|
+
Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time.
|
|
714
|
+
|
|
715
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
716
|
+
|
|
717
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
718
|
+
|
|
719
|
+
Parameters
|
|
720
|
+
----------
|
|
721
|
+
camera_id : int
|
|
722
|
+
The camera_id should be valid for the given accessToken.
|
|
723
|
+
|
|
724
|
+
program_id : typing.Optional[int]
|
|
725
|
+
The configured program's ID on the camera.
|
|
726
|
+
|
|
727
|
+
started_at_ms : typing.Optional[int]
|
|
728
|
+
EndMs is an optional param. It will default to the current time.
|
|
729
|
+
|
|
730
|
+
include : typing.Optional[str]
|
|
731
|
+
Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.
|
|
732
|
+
|
|
733
|
+
limit : typing.Optional[int]
|
|
734
|
+
Limit is an integer value from 1 to 1,000.
|
|
735
|
+
|
|
736
|
+
request_options : typing.Optional[RequestOptions]
|
|
737
|
+
Request-specific configuration.
|
|
738
|
+
|
|
739
|
+
Returns
|
|
740
|
+
-------
|
|
741
|
+
V1VisionRunByCameraResponse
|
|
742
|
+
Returns the details for this run.
|
|
743
|
+
|
|
744
|
+
Examples
|
|
745
|
+
--------
|
|
746
|
+
from samsara import Samsara
|
|
747
|
+
|
|
748
|
+
client = Samsara(
|
|
749
|
+
token="YOUR_TOKEN",
|
|
750
|
+
)
|
|
751
|
+
client.industrial.v_1_get_vision_latest_run_camera(
|
|
752
|
+
camera_id=1000000,
|
|
753
|
+
program_id=1000000,
|
|
754
|
+
started_at_ms=1000000,
|
|
755
|
+
include="include",
|
|
756
|
+
limit=1000000,
|
|
757
|
+
)
|
|
758
|
+
"""
|
|
759
|
+
_response = self._raw_client.v_1_get_vision_latest_run_camera(
|
|
760
|
+
camera_id,
|
|
761
|
+
program_id=program_id,
|
|
762
|
+
started_at_ms=started_at_ms,
|
|
763
|
+
include=include,
|
|
764
|
+
limit=limit,
|
|
765
|
+
request_options=request_options,
|
|
766
|
+
)
|
|
767
|
+
return _response.data
|
|
768
|
+
|
|
769
|
+
def v_1_get_vision_runs(
|
|
770
|
+
self,
|
|
771
|
+
*,
|
|
772
|
+
duration_ms: int,
|
|
773
|
+
end_ms: typing.Optional[int] = None,
|
|
774
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
775
|
+
) -> V1VisionRunsResponse:
|
|
776
|
+
"""
|
|
777
|
+
<n class="warning">
|
|
778
|
+
<nh>
|
|
779
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
780
|
+
This endpoint is still on our legacy API.
|
|
781
|
+
</nh>
|
|
782
|
+
</n>
|
|
783
|
+
|
|
784
|
+
Fetch runs.
|
|
785
|
+
|
|
786
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
787
|
+
|
|
788
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
789
|
+
|
|
790
|
+
Parameters
|
|
791
|
+
----------
|
|
792
|
+
duration_ms : int
|
|
793
|
+
DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
|
|
794
|
+
|
|
795
|
+
end_ms : typing.Optional[int]
|
|
796
|
+
EndMs is an optional param. It will default to the current time.
|
|
797
|
+
|
|
798
|
+
request_options : typing.Optional[RequestOptions]
|
|
799
|
+
Request-specific configuration.
|
|
800
|
+
|
|
801
|
+
Returns
|
|
802
|
+
-------
|
|
803
|
+
V1VisionRunsResponse
|
|
804
|
+
Return runs.
|
|
805
|
+
|
|
806
|
+
Examples
|
|
807
|
+
--------
|
|
808
|
+
from samsara import Samsara
|
|
809
|
+
|
|
810
|
+
client = Samsara(
|
|
811
|
+
token="YOUR_TOKEN",
|
|
812
|
+
)
|
|
813
|
+
client.industrial.v_1_get_vision_runs(
|
|
814
|
+
duration_ms=1000000,
|
|
815
|
+
end_ms=1000000,
|
|
816
|
+
)
|
|
817
|
+
"""
|
|
818
|
+
_response = self._raw_client.v_1_get_vision_runs(
|
|
819
|
+
duration_ms=duration_ms, end_ms=end_ms, request_options=request_options
|
|
820
|
+
)
|
|
821
|
+
return _response.data
|
|
822
|
+
|
|
823
|
+
def get_vision_runs_by_camera(
|
|
824
|
+
self,
|
|
825
|
+
camera_id: int,
|
|
826
|
+
*,
|
|
827
|
+
duration_ms: int,
|
|
828
|
+
end_ms: typing.Optional[int] = None,
|
|
829
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
830
|
+
) -> V1VisionRunsByCameraResponse:
|
|
831
|
+
"""
|
|
832
|
+
<n class="warning">
|
|
833
|
+
<nh>
|
|
834
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
835
|
+
This endpoint is still on our legacy API.
|
|
836
|
+
</nh>
|
|
837
|
+
</n>
|
|
838
|
+
|
|
839
|
+
Fetch runs by camera.
|
|
840
|
+
|
|
841
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
842
|
+
|
|
843
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
844
|
+
|
|
845
|
+
Parameters
|
|
846
|
+
----------
|
|
847
|
+
camera_id : int
|
|
848
|
+
The camera_id should be valid for the given accessToken.
|
|
849
|
+
|
|
850
|
+
duration_ms : int
|
|
851
|
+
DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
|
|
852
|
+
|
|
853
|
+
end_ms : typing.Optional[int]
|
|
854
|
+
EndMs is an optional param. It will default to the current time.
|
|
855
|
+
|
|
856
|
+
request_options : typing.Optional[RequestOptions]
|
|
857
|
+
Request-specific configuration.
|
|
858
|
+
|
|
859
|
+
Returns
|
|
860
|
+
-------
|
|
861
|
+
V1VisionRunsByCameraResponse
|
|
862
|
+
Return runs by cameraId.
|
|
863
|
+
|
|
864
|
+
Examples
|
|
865
|
+
--------
|
|
866
|
+
from samsara import Samsara
|
|
867
|
+
|
|
868
|
+
client = Samsara(
|
|
869
|
+
token="YOUR_TOKEN",
|
|
870
|
+
)
|
|
871
|
+
client.industrial.get_vision_runs_by_camera(
|
|
872
|
+
camera_id=1000000,
|
|
873
|
+
duration_ms=1000000,
|
|
874
|
+
end_ms=1000000,
|
|
875
|
+
)
|
|
876
|
+
"""
|
|
877
|
+
_response = self._raw_client.get_vision_runs_by_camera(
|
|
878
|
+
camera_id, duration_ms=duration_ms, end_ms=end_ms, request_options=request_options
|
|
879
|
+
)
|
|
880
|
+
return _response.data
|
|
881
|
+
|
|
882
|
+
def v_1_get_vision_runs_by_camera_and_program(
|
|
883
|
+
self,
|
|
884
|
+
camera_id: int,
|
|
885
|
+
program_id: int,
|
|
886
|
+
started_at_ms: int,
|
|
887
|
+
*,
|
|
888
|
+
include: typing.Optional[str] = None,
|
|
889
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
890
|
+
) -> V1VisionRunsByCameraAndProgramResponse:
|
|
891
|
+
"""
|
|
892
|
+
<n class="warning">
|
|
893
|
+
<nh>
|
|
894
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
895
|
+
This endpoint is still on our legacy API.
|
|
896
|
+
</nh>
|
|
897
|
+
</n>
|
|
898
|
+
|
|
899
|
+
Fetch runs by camera and program.
|
|
900
|
+
|
|
901
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
902
|
+
|
|
903
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
904
|
+
|
|
905
|
+
Parameters
|
|
906
|
+
----------
|
|
907
|
+
camera_id : int
|
|
908
|
+
The camera_id should be valid for the given accessToken.
|
|
909
|
+
|
|
910
|
+
program_id : int
|
|
911
|
+
The configured program's ID on the camera.
|
|
912
|
+
|
|
913
|
+
started_at_ms : int
|
|
914
|
+
Started_at_ms is a required param. Indicates the start time of the run to be fetched.
|
|
915
|
+
|
|
916
|
+
include : typing.Optional[str]
|
|
917
|
+
Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.
|
|
918
|
+
|
|
919
|
+
request_options : typing.Optional[RequestOptions]
|
|
920
|
+
Request-specific configuration.
|
|
921
|
+
|
|
922
|
+
Returns
|
|
923
|
+
-------
|
|
924
|
+
V1VisionRunsByCameraAndProgramResponse
|
|
925
|
+
Return runs by camera ID and program ID.
|
|
926
|
+
|
|
927
|
+
Examples
|
|
928
|
+
--------
|
|
929
|
+
from samsara import Samsara
|
|
930
|
+
|
|
931
|
+
client = Samsara(
|
|
932
|
+
token="YOUR_TOKEN",
|
|
933
|
+
)
|
|
934
|
+
client.industrial.v_1_get_vision_runs_by_camera_and_program(
|
|
935
|
+
camera_id=1000000,
|
|
936
|
+
program_id=1000000,
|
|
937
|
+
started_at_ms=1000000,
|
|
938
|
+
include="include",
|
|
939
|
+
)
|
|
940
|
+
"""
|
|
941
|
+
_response = self._raw_client.v_1_get_vision_runs_by_camera_and_program(
|
|
942
|
+
camera_id, program_id, started_at_ms, include=include, request_options=request_options
|
|
943
|
+
)
|
|
944
|
+
return _response.data
|
|
945
|
+
|
|
946
|
+
def v_1_get_machines_history(
|
|
947
|
+
self, *, end_ms: int, start_ms: int, request_options: typing.Optional[RequestOptions] = None
|
|
948
|
+
) -> V1MachineHistoryResponse:
|
|
949
|
+
"""
|
|
950
|
+
<n class="warning">
|
|
951
|
+
<nh>
|
|
952
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
953
|
+
This endpoint is still on our legacy API.
|
|
954
|
+
</nh>
|
|
955
|
+
</n>
|
|
956
|
+
|
|
957
|
+
Get historical data for machine objects. This method returns a set of historical data for all machines.
|
|
958
|
+
|
|
959
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
960
|
+
|
|
961
|
+
To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
962
|
+
|
|
963
|
+
Parameters
|
|
964
|
+
----------
|
|
965
|
+
end_ms : int
|
|
966
|
+
End of the time range, specified in milliseconds UNIX time.
|
|
967
|
+
|
|
968
|
+
start_ms : int
|
|
969
|
+
Beginning of the time range, specified in milliseconds UNIX time.
|
|
970
|
+
|
|
971
|
+
request_options : typing.Optional[RequestOptions]
|
|
972
|
+
Request-specific configuration.
|
|
973
|
+
|
|
974
|
+
Returns
|
|
975
|
+
-------
|
|
976
|
+
V1MachineHistoryResponse
|
|
977
|
+
List of machine results objects, each containing a time and a datapoint.
|
|
978
|
+
|
|
979
|
+
Examples
|
|
980
|
+
--------
|
|
981
|
+
from samsara import Samsara
|
|
982
|
+
|
|
983
|
+
client = Samsara(
|
|
984
|
+
token="YOUR_TOKEN",
|
|
985
|
+
)
|
|
986
|
+
client.industrial.v_1_get_machines_history(
|
|
987
|
+
end_ms=1462881998034,
|
|
988
|
+
start_ms=1462878398034,
|
|
989
|
+
)
|
|
990
|
+
"""
|
|
991
|
+
_response = self._raw_client.v_1_get_machines_history(
|
|
992
|
+
end_ms=end_ms, start_ms=start_ms, request_options=request_options
|
|
993
|
+
)
|
|
994
|
+
return _response.data
|
|
995
|
+
|
|
996
|
+
def v_1_get_machines(self, *, request_options: typing.Optional[RequestOptions] = None) -> InlineResponse2008:
|
|
997
|
+
"""
|
|
998
|
+
<n class="warning">
|
|
999
|
+
<nh>
|
|
1000
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
1001
|
+
This endpoint is still on our legacy API.
|
|
1002
|
+
</nh>
|
|
1003
|
+
</n>
|
|
1004
|
+
|
|
1005
|
+
Get machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them.
|
|
1006
|
+
|
|
1007
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1008
|
+
|
|
1009
|
+
To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1010
|
+
|
|
1011
|
+
Parameters
|
|
1012
|
+
----------
|
|
1013
|
+
request_options : typing.Optional[RequestOptions]
|
|
1014
|
+
Request-specific configuration.
|
|
1015
|
+
|
|
1016
|
+
Returns
|
|
1017
|
+
-------
|
|
1018
|
+
InlineResponse2008
|
|
1019
|
+
List of machine objects.
|
|
1020
|
+
|
|
1021
|
+
Examples
|
|
1022
|
+
--------
|
|
1023
|
+
from samsara import Samsara
|
|
1024
|
+
|
|
1025
|
+
client = Samsara(
|
|
1026
|
+
token="YOUR_TOKEN",
|
|
1027
|
+
)
|
|
1028
|
+
client.industrial.v_1_get_machines()
|
|
1029
|
+
"""
|
|
1030
|
+
_response = self._raw_client.v_1_get_machines(request_options=request_options)
|
|
1031
|
+
return _response.data
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
class AsyncIndustrialClient:
|
|
1035
|
+
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
|
1036
|
+
self._raw_client = AsyncRawIndustrialClient(client_wrapper=client_wrapper)
|
|
1037
|
+
|
|
1038
|
+
@property
|
|
1039
|
+
def with_raw_response(self) -> AsyncRawIndustrialClient:
|
|
1040
|
+
"""
|
|
1041
|
+
Retrieves a raw implementation of this client that returns raw responses.
|
|
1042
|
+
|
|
1043
|
+
Returns
|
|
1044
|
+
-------
|
|
1045
|
+
AsyncRawIndustrialClient
|
|
1046
|
+
"""
|
|
1047
|
+
return self._raw_client
|
|
1048
|
+
|
|
1049
|
+
async def get_industrial_assets(
|
|
1050
|
+
self,
|
|
1051
|
+
*,
|
|
1052
|
+
limit: typing.Optional[int] = None,
|
|
1053
|
+
after: typing.Optional[str] = None,
|
|
1054
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1055
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1056
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1057
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1058
|
+
) -> ListIndustrialAssetsResponse:
|
|
1059
|
+
"""
|
|
1060
|
+
List all assets in the organization.
|
|
1061
|
+
|
|
1062
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1063
|
+
|
|
1064
|
+
To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1065
|
+
|
|
1066
|
+
Parameters
|
|
1067
|
+
----------
|
|
1068
|
+
limit : typing.Optional[int]
|
|
1069
|
+
The limit for how many objects will be in the response. Default and max for this value is 512 objects.
|
|
1070
|
+
|
|
1071
|
+
after : typing.Optional[str]
|
|
1072
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
1073
|
+
|
|
1074
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1075
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
1076
|
+
|
|
1077
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1078
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
1079
|
+
|
|
1080
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1081
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
1082
|
+
|
|
1083
|
+
request_options : typing.Optional[RequestOptions]
|
|
1084
|
+
Request-specific configuration.
|
|
1085
|
+
|
|
1086
|
+
Returns
|
|
1087
|
+
-------
|
|
1088
|
+
ListIndustrialAssetsResponse
|
|
1089
|
+
Assets in the organization.
|
|
1090
|
+
|
|
1091
|
+
Examples
|
|
1092
|
+
--------
|
|
1093
|
+
import asyncio
|
|
1094
|
+
|
|
1095
|
+
from samsara import AsyncSamsara
|
|
1096
|
+
|
|
1097
|
+
client = AsyncSamsara(
|
|
1098
|
+
token="YOUR_TOKEN",
|
|
1099
|
+
)
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
async def main() -> None:
|
|
1103
|
+
await client.industrial.get_industrial_assets(
|
|
1104
|
+
limit=1000000,
|
|
1105
|
+
after="after",
|
|
1106
|
+
)
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
asyncio.run(main())
|
|
1110
|
+
"""
|
|
1111
|
+
_response = await self._raw_client.get_industrial_assets(
|
|
1112
|
+
limit=limit,
|
|
1113
|
+
after=after,
|
|
1114
|
+
parent_tag_ids=parent_tag_ids,
|
|
1115
|
+
tag_ids=tag_ids,
|
|
1116
|
+
asset_ids=asset_ids,
|
|
1117
|
+
request_options=request_options,
|
|
1118
|
+
)
|
|
1119
|
+
return _response.data
|
|
1120
|
+
|
|
1121
|
+
async def create_industrial_asset(
|
|
1122
|
+
self,
|
|
1123
|
+
*,
|
|
1124
|
+
name: AssetName,
|
|
1125
|
+
custom_metadata: typing.Optional[CustomMetadata] = OMIT,
|
|
1126
|
+
location: typing.Optional[AssetLocation] = OMIT,
|
|
1127
|
+
location_data_input_id: typing.Optional[str] = OMIT,
|
|
1128
|
+
location_type: typing.Optional[LocationType] = OMIT,
|
|
1129
|
+
parent_id: typing.Optional[ParentId] = OMIT,
|
|
1130
|
+
running_status_data_input_id: typing.Optional[str] = OMIT,
|
|
1131
|
+
tag_ids: typing.Optional[TagIds] = OMIT,
|
|
1132
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1133
|
+
) -> InlineResponse200:
|
|
1134
|
+
"""
|
|
1135
|
+
Create an asset with optional configuration parameters.
|
|
1136
|
+
|
|
1137
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1138
|
+
|
|
1139
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1140
|
+
|
|
1141
|
+
Parameters
|
|
1142
|
+
----------
|
|
1143
|
+
name : AssetName
|
|
1144
|
+
|
|
1145
|
+
custom_metadata : typing.Optional[CustomMetadata]
|
|
1146
|
+
|
|
1147
|
+
location : typing.Optional[AssetLocation]
|
|
1148
|
+
|
|
1149
|
+
location_data_input_id : typing.Optional[str]
|
|
1150
|
+
Required if locationType is "dataInput". Specifies the id of a location data input which will determine the asset's location. **The data input will be moved to the new asset.**
|
|
1151
|
+
|
|
1152
|
+
location_type : typing.Optional[LocationType]
|
|
1153
|
+
|
|
1154
|
+
parent_id : typing.Optional[ParentId]
|
|
1155
|
+
|
|
1156
|
+
running_status_data_input_id : typing.Optional[str]
|
|
1157
|
+
The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. **The data input will be moved to the new asset.**
|
|
1158
|
+
|
|
1159
|
+
tag_ids : typing.Optional[TagIds]
|
|
1160
|
+
|
|
1161
|
+
request_options : typing.Optional[RequestOptions]
|
|
1162
|
+
Request-specific configuration.
|
|
1163
|
+
|
|
1164
|
+
Returns
|
|
1165
|
+
-------
|
|
1166
|
+
InlineResponse200
|
|
1167
|
+
Newly created asset object
|
|
1168
|
+
|
|
1169
|
+
Examples
|
|
1170
|
+
--------
|
|
1171
|
+
import asyncio
|
|
1172
|
+
|
|
1173
|
+
from samsara import AsyncSamsara
|
|
1174
|
+
|
|
1175
|
+
client = AsyncSamsara(
|
|
1176
|
+
token="YOUR_TOKEN",
|
|
1177
|
+
)
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
async def main() -> None:
|
|
1181
|
+
await client.industrial.create_industrial_asset(
|
|
1182
|
+
name="name",
|
|
1183
|
+
)
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
asyncio.run(main())
|
|
1187
|
+
"""
|
|
1188
|
+
_response = await self._raw_client.create_industrial_asset(
|
|
1189
|
+
name=name,
|
|
1190
|
+
custom_metadata=custom_metadata,
|
|
1191
|
+
location=location,
|
|
1192
|
+
location_data_input_id=location_data_input_id,
|
|
1193
|
+
location_type=location_type,
|
|
1194
|
+
parent_id=parent_id,
|
|
1195
|
+
running_status_data_input_id=running_status_data_input_id,
|
|
1196
|
+
tag_ids=tag_ids,
|
|
1197
|
+
request_options=request_options,
|
|
1198
|
+
)
|
|
1199
|
+
return _response.data
|
|
1200
|
+
|
|
1201
|
+
async def delete_industrial_asset(
|
|
1202
|
+
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
1203
|
+
) -> StandardDeleteResponse:
|
|
1204
|
+
"""
|
|
1205
|
+
Delete asset.
|
|
1206
|
+
|
|
1207
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1208
|
+
|
|
1209
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1210
|
+
|
|
1211
|
+
Parameters
|
|
1212
|
+
----------
|
|
1213
|
+
id : str
|
|
1214
|
+
Id of the asset to be deleted.
|
|
1215
|
+
|
|
1216
|
+
request_options : typing.Optional[RequestOptions]
|
|
1217
|
+
Request-specific configuration.
|
|
1218
|
+
|
|
1219
|
+
Returns
|
|
1220
|
+
-------
|
|
1221
|
+
StandardDeleteResponse
|
|
1222
|
+
A successful DELETE response is a 204 with no content.
|
|
1223
|
+
|
|
1224
|
+
Examples
|
|
1225
|
+
--------
|
|
1226
|
+
import asyncio
|
|
1227
|
+
|
|
1228
|
+
from samsara import AsyncSamsara
|
|
1229
|
+
|
|
1230
|
+
client = AsyncSamsara(
|
|
1231
|
+
token="YOUR_TOKEN",
|
|
1232
|
+
)
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
async def main() -> None:
|
|
1236
|
+
await client.industrial.delete_industrial_asset(
|
|
1237
|
+
id="id",
|
|
1238
|
+
)
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
asyncio.run(main())
|
|
1242
|
+
"""
|
|
1243
|
+
_response = await self._raw_client.delete_industrial_asset(id, request_options=request_options)
|
|
1244
|
+
return _response.data
|
|
1245
|
+
|
|
1246
|
+
async def patch_industrial_asset(
|
|
1247
|
+
self,
|
|
1248
|
+
id: str,
|
|
1249
|
+
*,
|
|
1250
|
+
custom_metadata: typing.Optional[CustomMetadata] = OMIT,
|
|
1251
|
+
location: typing.Optional[AssetLocation] = OMIT,
|
|
1252
|
+
location_data_input_id: typing.Optional[str] = OMIT,
|
|
1253
|
+
location_type: typing.Optional[LocationType] = OMIT,
|
|
1254
|
+
name: typing.Optional[AssetName] = OMIT,
|
|
1255
|
+
parent_id: typing.Optional[str] = OMIT,
|
|
1256
|
+
running_status_data_input_id: typing.Optional[str] = OMIT,
|
|
1257
|
+
tag_ids: typing.Optional[TagIds] = OMIT,
|
|
1258
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1259
|
+
) -> InlineResponse200:
|
|
1260
|
+
"""
|
|
1261
|
+
Update an existing asset. Only the provided fields will be updated.
|
|
1262
|
+
|
|
1263
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1264
|
+
|
|
1265
|
+
To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1266
|
+
|
|
1267
|
+
Parameters
|
|
1268
|
+
----------
|
|
1269
|
+
id : str
|
|
1270
|
+
Id of the asset to be updated
|
|
1271
|
+
|
|
1272
|
+
custom_metadata : typing.Optional[CustomMetadata]
|
|
1273
|
+
|
|
1274
|
+
location : typing.Optional[AssetLocation]
|
|
1275
|
+
|
|
1276
|
+
location_data_input_id : typing.Optional[str]
|
|
1277
|
+
Required if locationType is "dataInput". Specifies the id of a location data input which will determine the asset's location. The data input must be in the asset.
|
|
1278
|
+
|
|
1279
|
+
location_type : typing.Optional[LocationType]
|
|
1280
|
+
|
|
1281
|
+
name : typing.Optional[AssetName]
|
|
1282
|
+
|
|
1283
|
+
parent_id : typing.Optional[str]
|
|
1284
|
+
The id of the parent asset that the asset belongs to. Pass in an empty string to remove the child from the parent.
|
|
1285
|
+
|
|
1286
|
+
running_status_data_input_id : typing.Optional[str]
|
|
1287
|
+
The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. The data input must be in the asset.
|
|
1288
|
+
|
|
1289
|
+
tag_ids : typing.Optional[TagIds]
|
|
1290
|
+
|
|
1291
|
+
request_options : typing.Optional[RequestOptions]
|
|
1292
|
+
Request-specific configuration.
|
|
1293
|
+
|
|
1294
|
+
Returns
|
|
1295
|
+
-------
|
|
1296
|
+
InlineResponse200
|
|
1297
|
+
The updated asset
|
|
1298
|
+
|
|
1299
|
+
Examples
|
|
1300
|
+
--------
|
|
1301
|
+
import asyncio
|
|
1302
|
+
|
|
1303
|
+
from samsara import AsyncSamsara
|
|
1304
|
+
|
|
1305
|
+
client = AsyncSamsara(
|
|
1306
|
+
token="YOUR_TOKEN",
|
|
1307
|
+
)
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
async def main() -> None:
|
|
1311
|
+
await client.industrial.patch_industrial_asset(
|
|
1312
|
+
id="id",
|
|
1313
|
+
)
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
asyncio.run(main())
|
|
1317
|
+
"""
|
|
1318
|
+
_response = await self._raw_client.patch_industrial_asset(
|
|
1319
|
+
id,
|
|
1320
|
+
custom_metadata=custom_metadata,
|
|
1321
|
+
location=location,
|
|
1322
|
+
location_data_input_id=location_data_input_id,
|
|
1323
|
+
location_type=location_type,
|
|
1324
|
+
name=name,
|
|
1325
|
+
parent_id=parent_id,
|
|
1326
|
+
running_status_data_input_id=running_status_data_input_id,
|
|
1327
|
+
tag_ids=tag_ids,
|
|
1328
|
+
request_options=request_options,
|
|
1329
|
+
)
|
|
1330
|
+
return _response.data
|
|
1331
|
+
|
|
1332
|
+
async def patch_asset_data_outputs(
|
|
1333
|
+
self,
|
|
1334
|
+
id: str,
|
|
1335
|
+
*,
|
|
1336
|
+
values: typing.Dict[str, typing.Optional[typing.Any]],
|
|
1337
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1338
|
+
) -> AssetDataOutputsPatchAssetDataOutputsResponseBody:
|
|
1339
|
+
"""
|
|
1340
|
+
Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated.
|
|
1341
|
+
|
|
1342
|
+
<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
|
|
1343
|
+
|
|
1344
|
+
To use this endpoint, select **Write Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1348
|
+
|
|
1349
|
+
Parameters
|
|
1350
|
+
----------
|
|
1351
|
+
id : str
|
|
1352
|
+
Asset ID
|
|
1353
|
+
|
|
1354
|
+
values : typing.Dict[str, typing.Optional[typing.Any]]
|
|
1355
|
+
A map of data output IDs to values. All data outputs must belong to the same asset. Only the specified IDs will be written to.
|
|
1356
|
+
|
|
1357
|
+
request_options : typing.Optional[RequestOptions]
|
|
1358
|
+
Request-specific configuration.
|
|
1359
|
+
|
|
1360
|
+
Returns
|
|
1361
|
+
-------
|
|
1362
|
+
AssetDataOutputsPatchAssetDataOutputsResponseBody
|
|
1363
|
+
OK response.
|
|
1364
|
+
|
|
1365
|
+
Examples
|
|
1366
|
+
--------
|
|
1367
|
+
import asyncio
|
|
1368
|
+
|
|
1369
|
+
from samsara import AsyncSamsara
|
|
1370
|
+
|
|
1371
|
+
client = AsyncSamsara(
|
|
1372
|
+
token="YOUR_TOKEN",
|
|
1373
|
+
)
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
async def main() -> None:
|
|
1377
|
+
await client.industrial.patch_asset_data_outputs(
|
|
1378
|
+
id="id",
|
|
1379
|
+
values={"key": "value"},
|
|
1380
|
+
)
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
asyncio.run(main())
|
|
1384
|
+
"""
|
|
1385
|
+
_response = await self._raw_client.patch_asset_data_outputs(id, values=values, request_options=request_options)
|
|
1386
|
+
return _response.data
|
|
1387
|
+
|
|
1388
|
+
async def get_data_inputs(
|
|
1389
|
+
self,
|
|
1390
|
+
*,
|
|
1391
|
+
limit: typing.Optional[int] = None,
|
|
1392
|
+
after: typing.Optional[str] = None,
|
|
1393
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1394
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1395
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1396
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1397
|
+
) -> DataInputsTinyResponse:
|
|
1398
|
+
"""
|
|
1399
|
+
Returns all data inputs, optionally filtered by tags or asset ids.
|
|
1400
|
+
|
|
1401
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1402
|
+
|
|
1403
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1404
|
+
|
|
1405
|
+
Parameters
|
|
1406
|
+
----------
|
|
1407
|
+
limit : typing.Optional[int]
|
|
1408
|
+
The limit for how many objects will be in the response. Default and max for this value is 512 objects.
|
|
1409
|
+
|
|
1410
|
+
after : typing.Optional[str]
|
|
1411
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
1412
|
+
|
|
1413
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1414
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
1415
|
+
|
|
1416
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1417
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
1418
|
+
|
|
1419
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1420
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
1421
|
+
|
|
1422
|
+
request_options : typing.Optional[RequestOptions]
|
|
1423
|
+
Request-specific configuration.
|
|
1424
|
+
|
|
1425
|
+
Returns
|
|
1426
|
+
-------
|
|
1427
|
+
DataInputsTinyResponse
|
|
1428
|
+
List of data inputs with names, ids, and other metadata.
|
|
1429
|
+
|
|
1430
|
+
Examples
|
|
1431
|
+
--------
|
|
1432
|
+
import asyncio
|
|
1433
|
+
|
|
1434
|
+
from samsara import AsyncSamsara
|
|
1435
|
+
|
|
1436
|
+
client = AsyncSamsara(
|
|
1437
|
+
token="YOUR_TOKEN",
|
|
1438
|
+
)
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
async def main() -> None:
|
|
1442
|
+
await client.industrial.get_data_inputs(
|
|
1443
|
+
limit=1000000,
|
|
1444
|
+
after="after",
|
|
1445
|
+
)
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
asyncio.run(main())
|
|
1449
|
+
"""
|
|
1450
|
+
_response = await self._raw_client.get_data_inputs(
|
|
1451
|
+
limit=limit,
|
|
1452
|
+
after=after,
|
|
1453
|
+
parent_tag_ids=parent_tag_ids,
|
|
1454
|
+
tag_ids=tag_ids,
|
|
1455
|
+
asset_ids=asset_ids,
|
|
1456
|
+
request_options=request_options,
|
|
1457
|
+
)
|
|
1458
|
+
return _response.data
|
|
1459
|
+
|
|
1460
|
+
async def get_data_input_data_snapshot(
|
|
1461
|
+
self,
|
|
1462
|
+
*,
|
|
1463
|
+
after: typing.Optional[str] = None,
|
|
1464
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1465
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1466
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1467
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1468
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1469
|
+
) -> DataInputSnapshotResponse:
|
|
1470
|
+
"""
|
|
1471
|
+
Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs.
|
|
1472
|
+
|
|
1473
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1474
|
+
|
|
1475
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1476
|
+
|
|
1477
|
+
Parameters
|
|
1478
|
+
----------
|
|
1479
|
+
after : typing.Optional[str]
|
|
1480
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
1481
|
+
|
|
1482
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1483
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
1484
|
+
|
|
1485
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1486
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
1487
|
+
|
|
1488
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1489
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
1490
|
+
|
|
1491
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1492
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
1493
|
+
|
|
1494
|
+
request_options : typing.Optional[RequestOptions]
|
|
1495
|
+
Request-specific configuration.
|
|
1496
|
+
|
|
1497
|
+
Returns
|
|
1498
|
+
-------
|
|
1499
|
+
DataInputSnapshotResponse
|
|
1500
|
+
List of last known data input data points and pagination parameters
|
|
1501
|
+
|
|
1502
|
+
Examples
|
|
1503
|
+
--------
|
|
1504
|
+
import asyncio
|
|
1505
|
+
|
|
1506
|
+
from samsara import AsyncSamsara
|
|
1507
|
+
|
|
1508
|
+
client = AsyncSamsara(
|
|
1509
|
+
token="YOUR_TOKEN",
|
|
1510
|
+
)
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
async def main() -> None:
|
|
1514
|
+
await client.industrial.get_data_input_data_snapshot(
|
|
1515
|
+
after="after",
|
|
1516
|
+
)
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
asyncio.run(main())
|
|
1520
|
+
"""
|
|
1521
|
+
_response = await self._raw_client.get_data_input_data_snapshot(
|
|
1522
|
+
after=after,
|
|
1523
|
+
parent_tag_ids=parent_tag_ids,
|
|
1524
|
+
tag_ids=tag_ids,
|
|
1525
|
+
data_input_ids=data_input_ids,
|
|
1526
|
+
asset_ids=asset_ids,
|
|
1527
|
+
request_options=request_options,
|
|
1528
|
+
)
|
|
1529
|
+
return _response.data
|
|
1530
|
+
|
|
1531
|
+
async def get_data_input_data_feed(
|
|
1532
|
+
self,
|
|
1533
|
+
*,
|
|
1534
|
+
after: typing.Optional[str] = None,
|
|
1535
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1536
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1537
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1538
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1539
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1540
|
+
) -> DataInputListResponse:
|
|
1541
|
+
"""
|
|
1542
|
+
Follow a continuous feed of all data input data points.
|
|
1543
|
+
|
|
1544
|
+
Your first call to this endpoint will provide you with the most recent data points for each data input and a `pagination` object that contains an `endCursor`.
|
|
1545
|
+
|
|
1546
|
+
You can provide the `endCursor` to the `after` parameter of this endpoint to get data point updates since that `endCursor`.
|
|
1547
|
+
|
|
1548
|
+
If `hasNextPage` is `false`, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates.
|
|
1549
|
+
|
|
1550
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1551
|
+
|
|
1552
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1553
|
+
|
|
1554
|
+
Parameters
|
|
1555
|
+
----------
|
|
1556
|
+
after : typing.Optional[str]
|
|
1557
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
1558
|
+
|
|
1559
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1560
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
1561
|
+
|
|
1562
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1563
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
1564
|
+
|
|
1565
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1566
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
1567
|
+
|
|
1568
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1569
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
1570
|
+
|
|
1571
|
+
request_options : typing.Optional[RequestOptions]
|
|
1572
|
+
Request-specific configuration.
|
|
1573
|
+
|
|
1574
|
+
Returns
|
|
1575
|
+
-------
|
|
1576
|
+
DataInputListResponse
|
|
1577
|
+
List of all data points for specified data inputs
|
|
1578
|
+
|
|
1579
|
+
Examples
|
|
1580
|
+
--------
|
|
1581
|
+
import asyncio
|
|
1582
|
+
|
|
1583
|
+
from samsara import AsyncSamsara
|
|
1584
|
+
|
|
1585
|
+
client = AsyncSamsara(
|
|
1586
|
+
token="YOUR_TOKEN",
|
|
1587
|
+
)
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
async def main() -> None:
|
|
1591
|
+
await client.industrial.get_data_input_data_feed(
|
|
1592
|
+
after="after",
|
|
1593
|
+
)
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
asyncio.run(main())
|
|
1597
|
+
"""
|
|
1598
|
+
_response = await self._raw_client.get_data_input_data_feed(
|
|
1599
|
+
after=after,
|
|
1600
|
+
parent_tag_ids=parent_tag_ids,
|
|
1601
|
+
tag_ids=tag_ids,
|
|
1602
|
+
data_input_ids=data_input_ids,
|
|
1603
|
+
asset_ids=asset_ids,
|
|
1604
|
+
request_options=request_options,
|
|
1605
|
+
)
|
|
1606
|
+
return _response.data
|
|
1607
|
+
|
|
1608
|
+
async def get_data_input_data_history(
|
|
1609
|
+
self,
|
|
1610
|
+
*,
|
|
1611
|
+
start_time: str,
|
|
1612
|
+
end_time: str,
|
|
1613
|
+
after: typing.Optional[str] = None,
|
|
1614
|
+
parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1615
|
+
tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1616
|
+
data_input_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1617
|
+
asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
|
|
1618
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1619
|
+
) -> DataInputListResponse:
|
|
1620
|
+
"""
|
|
1621
|
+
Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs.
|
|
1622
|
+
|
|
1623
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1624
|
+
|
|
1625
|
+
To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1626
|
+
|
|
1627
|
+
Parameters
|
|
1628
|
+
----------
|
|
1629
|
+
start_time : str
|
|
1630
|
+
A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
|
|
1631
|
+
|
|
1632
|
+
end_time : str
|
|
1633
|
+
An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
|
|
1634
|
+
|
|
1635
|
+
after : typing.Optional[str]
|
|
1636
|
+
If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
|
|
1637
|
+
|
|
1638
|
+
parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1639
|
+
A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
|
|
1640
|
+
|
|
1641
|
+
tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1642
|
+
A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
|
|
1643
|
+
|
|
1644
|
+
data_input_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1645
|
+
A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
|
|
1646
|
+
|
|
1647
|
+
asset_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
|
1648
|
+
A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
|
|
1649
|
+
|
|
1650
|
+
request_options : typing.Optional[RequestOptions]
|
|
1651
|
+
Request-specific configuration.
|
|
1652
|
+
|
|
1653
|
+
Returns
|
|
1654
|
+
-------
|
|
1655
|
+
DataInputListResponse
|
|
1656
|
+
List of all data points for the specified data inputs and time range.
|
|
1657
|
+
|
|
1658
|
+
Examples
|
|
1659
|
+
--------
|
|
1660
|
+
import asyncio
|
|
1661
|
+
|
|
1662
|
+
from samsara import AsyncSamsara
|
|
1663
|
+
|
|
1664
|
+
client = AsyncSamsara(
|
|
1665
|
+
token="YOUR_TOKEN",
|
|
1666
|
+
)
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
async def main() -> None:
|
|
1670
|
+
await client.industrial.get_data_input_data_history(
|
|
1671
|
+
start_time="startTime",
|
|
1672
|
+
end_time="endTime",
|
|
1673
|
+
after="after",
|
|
1674
|
+
)
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
asyncio.run(main())
|
|
1678
|
+
"""
|
|
1679
|
+
_response = await self._raw_client.get_data_input_data_history(
|
|
1680
|
+
start_time=start_time,
|
|
1681
|
+
end_time=end_time,
|
|
1682
|
+
after=after,
|
|
1683
|
+
parent_tag_ids=parent_tag_ids,
|
|
1684
|
+
tag_ids=tag_ids,
|
|
1685
|
+
data_input_ids=data_input_ids,
|
|
1686
|
+
asset_ids=asset_ids,
|
|
1687
|
+
request_options=request_options,
|
|
1688
|
+
)
|
|
1689
|
+
return _response.data
|
|
1690
|
+
|
|
1691
|
+
async def v_1_get_cameras(
|
|
1692
|
+
self, *, request_options: typing.Optional[RequestOptions] = None
|
|
1693
|
+
) -> V1VisionCamerasResponse:
|
|
1694
|
+
"""
|
|
1695
|
+
<n class="warning">
|
|
1696
|
+
<nh>
|
|
1697
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
1698
|
+
This endpoint is still on our legacy API.
|
|
1699
|
+
</nh>
|
|
1700
|
+
</n>
|
|
1701
|
+
|
|
1702
|
+
Fetch all cameras.
|
|
1703
|
+
|
|
1704
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1705
|
+
|
|
1706
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1707
|
+
|
|
1708
|
+
Parameters
|
|
1709
|
+
----------
|
|
1710
|
+
request_options : typing.Optional[RequestOptions]
|
|
1711
|
+
Request-specific configuration.
|
|
1712
|
+
|
|
1713
|
+
Returns
|
|
1714
|
+
-------
|
|
1715
|
+
V1VisionCamerasResponse
|
|
1716
|
+
Returns details about a camera.
|
|
1717
|
+
|
|
1718
|
+
Examples
|
|
1719
|
+
--------
|
|
1720
|
+
import asyncio
|
|
1721
|
+
|
|
1722
|
+
from samsara import AsyncSamsara
|
|
1723
|
+
|
|
1724
|
+
client = AsyncSamsara(
|
|
1725
|
+
token="YOUR_TOKEN",
|
|
1726
|
+
)
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
async def main() -> None:
|
|
1730
|
+
await client.industrial.v_1_get_cameras()
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
asyncio.run(main())
|
|
1734
|
+
"""
|
|
1735
|
+
_response = await self._raw_client.v_1_get_cameras(request_options=request_options)
|
|
1736
|
+
return _response.data
|
|
1737
|
+
|
|
1738
|
+
async def v_1_get_vision_programs_by_camera(
|
|
1739
|
+
self, camera_id: int, *, request_options: typing.Optional[RequestOptions] = None
|
|
1740
|
+
) -> V1ProgramsForTheCameraResponse:
|
|
1741
|
+
"""
|
|
1742
|
+
<n class="warning">
|
|
1743
|
+
<nh>
|
|
1744
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
1745
|
+
This endpoint is still on our legacy API.
|
|
1746
|
+
</nh>
|
|
1747
|
+
</n>
|
|
1748
|
+
|
|
1749
|
+
Fetch configured programs on the camera.
|
|
1750
|
+
|
|
1751
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1752
|
+
|
|
1753
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1754
|
+
|
|
1755
|
+
Parameters
|
|
1756
|
+
----------
|
|
1757
|
+
camera_id : int
|
|
1758
|
+
The camera_id should be valid for the given accessToken.
|
|
1759
|
+
|
|
1760
|
+
request_options : typing.Optional[RequestOptions]
|
|
1761
|
+
Request-specific configuration.
|
|
1762
|
+
|
|
1763
|
+
Returns
|
|
1764
|
+
-------
|
|
1765
|
+
V1ProgramsForTheCameraResponse
|
|
1766
|
+
Returns programs configured on the camera.
|
|
1767
|
+
|
|
1768
|
+
Examples
|
|
1769
|
+
--------
|
|
1770
|
+
import asyncio
|
|
1771
|
+
|
|
1772
|
+
from samsara import AsyncSamsara
|
|
1773
|
+
|
|
1774
|
+
client = AsyncSamsara(
|
|
1775
|
+
token="YOUR_TOKEN",
|
|
1776
|
+
)
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
async def main() -> None:
|
|
1780
|
+
await client.industrial.v_1_get_vision_programs_by_camera(
|
|
1781
|
+
camera_id=1000000,
|
|
1782
|
+
)
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
asyncio.run(main())
|
|
1786
|
+
"""
|
|
1787
|
+
_response = await self._raw_client.v_1_get_vision_programs_by_camera(camera_id, request_options=request_options)
|
|
1788
|
+
return _response.data
|
|
1789
|
+
|
|
1790
|
+
async def v_1_get_vision_latest_run_camera(
|
|
1791
|
+
self,
|
|
1792
|
+
camera_id: int,
|
|
1793
|
+
*,
|
|
1794
|
+
program_id: typing.Optional[int] = None,
|
|
1795
|
+
started_at_ms: typing.Optional[int] = None,
|
|
1796
|
+
include: typing.Optional[str] = None,
|
|
1797
|
+
limit: typing.Optional[int] = None,
|
|
1798
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1799
|
+
) -> V1VisionRunByCameraResponse:
|
|
1800
|
+
"""
|
|
1801
|
+
Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time.
|
|
1802
|
+
|
|
1803
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1804
|
+
|
|
1805
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1806
|
+
|
|
1807
|
+
Parameters
|
|
1808
|
+
----------
|
|
1809
|
+
camera_id : int
|
|
1810
|
+
The camera_id should be valid for the given accessToken.
|
|
1811
|
+
|
|
1812
|
+
program_id : typing.Optional[int]
|
|
1813
|
+
The configured program's ID on the camera.
|
|
1814
|
+
|
|
1815
|
+
started_at_ms : typing.Optional[int]
|
|
1816
|
+
EndMs is an optional param. It will default to the current time.
|
|
1817
|
+
|
|
1818
|
+
include : typing.Optional[str]
|
|
1819
|
+
Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.
|
|
1820
|
+
|
|
1821
|
+
limit : typing.Optional[int]
|
|
1822
|
+
Limit is an integer value from 1 to 1,000.
|
|
1823
|
+
|
|
1824
|
+
request_options : typing.Optional[RequestOptions]
|
|
1825
|
+
Request-specific configuration.
|
|
1826
|
+
|
|
1827
|
+
Returns
|
|
1828
|
+
-------
|
|
1829
|
+
V1VisionRunByCameraResponse
|
|
1830
|
+
Returns the details for this run.
|
|
1831
|
+
|
|
1832
|
+
Examples
|
|
1833
|
+
--------
|
|
1834
|
+
import asyncio
|
|
1835
|
+
|
|
1836
|
+
from samsara import AsyncSamsara
|
|
1837
|
+
|
|
1838
|
+
client = AsyncSamsara(
|
|
1839
|
+
token="YOUR_TOKEN",
|
|
1840
|
+
)
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
async def main() -> None:
|
|
1844
|
+
await client.industrial.v_1_get_vision_latest_run_camera(
|
|
1845
|
+
camera_id=1000000,
|
|
1846
|
+
program_id=1000000,
|
|
1847
|
+
started_at_ms=1000000,
|
|
1848
|
+
include="include",
|
|
1849
|
+
limit=1000000,
|
|
1850
|
+
)
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
asyncio.run(main())
|
|
1854
|
+
"""
|
|
1855
|
+
_response = await self._raw_client.v_1_get_vision_latest_run_camera(
|
|
1856
|
+
camera_id,
|
|
1857
|
+
program_id=program_id,
|
|
1858
|
+
started_at_ms=started_at_ms,
|
|
1859
|
+
include=include,
|
|
1860
|
+
limit=limit,
|
|
1861
|
+
request_options=request_options,
|
|
1862
|
+
)
|
|
1863
|
+
return _response.data
|
|
1864
|
+
|
|
1865
|
+
async def v_1_get_vision_runs(
|
|
1866
|
+
self,
|
|
1867
|
+
*,
|
|
1868
|
+
duration_ms: int,
|
|
1869
|
+
end_ms: typing.Optional[int] = None,
|
|
1870
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1871
|
+
) -> V1VisionRunsResponse:
|
|
1872
|
+
"""
|
|
1873
|
+
<n class="warning">
|
|
1874
|
+
<nh>
|
|
1875
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
1876
|
+
This endpoint is still on our legacy API.
|
|
1877
|
+
</nh>
|
|
1878
|
+
</n>
|
|
1879
|
+
|
|
1880
|
+
Fetch runs.
|
|
1881
|
+
|
|
1882
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1883
|
+
|
|
1884
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1885
|
+
|
|
1886
|
+
Parameters
|
|
1887
|
+
----------
|
|
1888
|
+
duration_ms : int
|
|
1889
|
+
DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
|
|
1890
|
+
|
|
1891
|
+
end_ms : typing.Optional[int]
|
|
1892
|
+
EndMs is an optional param. It will default to the current time.
|
|
1893
|
+
|
|
1894
|
+
request_options : typing.Optional[RequestOptions]
|
|
1895
|
+
Request-specific configuration.
|
|
1896
|
+
|
|
1897
|
+
Returns
|
|
1898
|
+
-------
|
|
1899
|
+
V1VisionRunsResponse
|
|
1900
|
+
Return runs.
|
|
1901
|
+
|
|
1902
|
+
Examples
|
|
1903
|
+
--------
|
|
1904
|
+
import asyncio
|
|
1905
|
+
|
|
1906
|
+
from samsara import AsyncSamsara
|
|
1907
|
+
|
|
1908
|
+
client = AsyncSamsara(
|
|
1909
|
+
token="YOUR_TOKEN",
|
|
1910
|
+
)
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
async def main() -> None:
|
|
1914
|
+
await client.industrial.v_1_get_vision_runs(
|
|
1915
|
+
duration_ms=1000000,
|
|
1916
|
+
end_ms=1000000,
|
|
1917
|
+
)
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
asyncio.run(main())
|
|
1921
|
+
"""
|
|
1922
|
+
_response = await self._raw_client.v_1_get_vision_runs(
|
|
1923
|
+
duration_ms=duration_ms, end_ms=end_ms, request_options=request_options
|
|
1924
|
+
)
|
|
1925
|
+
return _response.data
|
|
1926
|
+
|
|
1927
|
+
async def get_vision_runs_by_camera(
|
|
1928
|
+
self,
|
|
1929
|
+
camera_id: int,
|
|
1930
|
+
*,
|
|
1931
|
+
duration_ms: int,
|
|
1932
|
+
end_ms: typing.Optional[int] = None,
|
|
1933
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
1934
|
+
) -> V1VisionRunsByCameraResponse:
|
|
1935
|
+
"""
|
|
1936
|
+
<n class="warning">
|
|
1937
|
+
<nh>
|
|
1938
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
1939
|
+
This endpoint is still on our legacy API.
|
|
1940
|
+
</nh>
|
|
1941
|
+
</n>
|
|
1942
|
+
|
|
1943
|
+
Fetch runs by camera.
|
|
1944
|
+
|
|
1945
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
1946
|
+
|
|
1947
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
1948
|
+
|
|
1949
|
+
Parameters
|
|
1950
|
+
----------
|
|
1951
|
+
camera_id : int
|
|
1952
|
+
The camera_id should be valid for the given accessToken.
|
|
1953
|
+
|
|
1954
|
+
duration_ms : int
|
|
1955
|
+
DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
|
|
1956
|
+
|
|
1957
|
+
end_ms : typing.Optional[int]
|
|
1958
|
+
EndMs is an optional param. It will default to the current time.
|
|
1959
|
+
|
|
1960
|
+
request_options : typing.Optional[RequestOptions]
|
|
1961
|
+
Request-specific configuration.
|
|
1962
|
+
|
|
1963
|
+
Returns
|
|
1964
|
+
-------
|
|
1965
|
+
V1VisionRunsByCameraResponse
|
|
1966
|
+
Return runs by cameraId.
|
|
1967
|
+
|
|
1968
|
+
Examples
|
|
1969
|
+
--------
|
|
1970
|
+
import asyncio
|
|
1971
|
+
|
|
1972
|
+
from samsara import AsyncSamsara
|
|
1973
|
+
|
|
1974
|
+
client = AsyncSamsara(
|
|
1975
|
+
token="YOUR_TOKEN",
|
|
1976
|
+
)
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
async def main() -> None:
|
|
1980
|
+
await client.industrial.get_vision_runs_by_camera(
|
|
1981
|
+
camera_id=1000000,
|
|
1982
|
+
duration_ms=1000000,
|
|
1983
|
+
end_ms=1000000,
|
|
1984
|
+
)
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
asyncio.run(main())
|
|
1988
|
+
"""
|
|
1989
|
+
_response = await self._raw_client.get_vision_runs_by_camera(
|
|
1990
|
+
camera_id, duration_ms=duration_ms, end_ms=end_ms, request_options=request_options
|
|
1991
|
+
)
|
|
1992
|
+
return _response.data
|
|
1993
|
+
|
|
1994
|
+
async def v_1_get_vision_runs_by_camera_and_program(
|
|
1995
|
+
self,
|
|
1996
|
+
camera_id: int,
|
|
1997
|
+
program_id: int,
|
|
1998
|
+
started_at_ms: int,
|
|
1999
|
+
*,
|
|
2000
|
+
include: typing.Optional[str] = None,
|
|
2001
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
2002
|
+
) -> V1VisionRunsByCameraAndProgramResponse:
|
|
2003
|
+
"""
|
|
2004
|
+
<n class="warning">
|
|
2005
|
+
<nh>
|
|
2006
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
2007
|
+
This endpoint is still on our legacy API.
|
|
2008
|
+
</nh>
|
|
2009
|
+
</n>
|
|
2010
|
+
|
|
2011
|
+
Fetch runs by camera and program.
|
|
2012
|
+
|
|
2013
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
2014
|
+
|
|
2015
|
+
To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
2016
|
+
|
|
2017
|
+
Parameters
|
|
2018
|
+
----------
|
|
2019
|
+
camera_id : int
|
|
2020
|
+
The camera_id should be valid for the given accessToken.
|
|
2021
|
+
|
|
2022
|
+
program_id : int
|
|
2023
|
+
The configured program's ID on the camera.
|
|
2024
|
+
|
|
2025
|
+
started_at_ms : int
|
|
2026
|
+
Started_at_ms is a required param. Indicates the start time of the run to be fetched.
|
|
2027
|
+
|
|
2028
|
+
include : typing.Optional[str]
|
|
2029
|
+
Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.
|
|
2030
|
+
|
|
2031
|
+
request_options : typing.Optional[RequestOptions]
|
|
2032
|
+
Request-specific configuration.
|
|
2033
|
+
|
|
2034
|
+
Returns
|
|
2035
|
+
-------
|
|
2036
|
+
V1VisionRunsByCameraAndProgramResponse
|
|
2037
|
+
Return runs by camera ID and program ID.
|
|
2038
|
+
|
|
2039
|
+
Examples
|
|
2040
|
+
--------
|
|
2041
|
+
import asyncio
|
|
2042
|
+
|
|
2043
|
+
from samsara import AsyncSamsara
|
|
2044
|
+
|
|
2045
|
+
client = AsyncSamsara(
|
|
2046
|
+
token="YOUR_TOKEN",
|
|
2047
|
+
)
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
async def main() -> None:
|
|
2051
|
+
await client.industrial.v_1_get_vision_runs_by_camera_and_program(
|
|
2052
|
+
camera_id=1000000,
|
|
2053
|
+
program_id=1000000,
|
|
2054
|
+
started_at_ms=1000000,
|
|
2055
|
+
include="include",
|
|
2056
|
+
)
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
asyncio.run(main())
|
|
2060
|
+
"""
|
|
2061
|
+
_response = await self._raw_client.v_1_get_vision_runs_by_camera_and_program(
|
|
2062
|
+
camera_id, program_id, started_at_ms, include=include, request_options=request_options
|
|
2063
|
+
)
|
|
2064
|
+
return _response.data
|
|
2065
|
+
|
|
2066
|
+
async def v_1_get_machines_history(
|
|
2067
|
+
self, *, end_ms: int, start_ms: int, request_options: typing.Optional[RequestOptions] = None
|
|
2068
|
+
) -> V1MachineHistoryResponse:
|
|
2069
|
+
"""
|
|
2070
|
+
<n class="warning">
|
|
2071
|
+
<nh>
|
|
2072
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
2073
|
+
This endpoint is still on our legacy API.
|
|
2074
|
+
</nh>
|
|
2075
|
+
</n>
|
|
2076
|
+
|
|
2077
|
+
Get historical data for machine objects. This method returns a set of historical data for all machines.
|
|
2078
|
+
|
|
2079
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
2080
|
+
|
|
2081
|
+
To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
2082
|
+
|
|
2083
|
+
Parameters
|
|
2084
|
+
----------
|
|
2085
|
+
end_ms : int
|
|
2086
|
+
End of the time range, specified in milliseconds UNIX time.
|
|
2087
|
+
|
|
2088
|
+
start_ms : int
|
|
2089
|
+
Beginning of the time range, specified in milliseconds UNIX time.
|
|
2090
|
+
|
|
2091
|
+
request_options : typing.Optional[RequestOptions]
|
|
2092
|
+
Request-specific configuration.
|
|
2093
|
+
|
|
2094
|
+
Returns
|
|
2095
|
+
-------
|
|
2096
|
+
V1MachineHistoryResponse
|
|
2097
|
+
List of machine results objects, each containing a time and a datapoint.
|
|
2098
|
+
|
|
2099
|
+
Examples
|
|
2100
|
+
--------
|
|
2101
|
+
import asyncio
|
|
2102
|
+
|
|
2103
|
+
from samsara import AsyncSamsara
|
|
2104
|
+
|
|
2105
|
+
client = AsyncSamsara(
|
|
2106
|
+
token="YOUR_TOKEN",
|
|
2107
|
+
)
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
async def main() -> None:
|
|
2111
|
+
await client.industrial.v_1_get_machines_history(
|
|
2112
|
+
end_ms=1462881998034,
|
|
2113
|
+
start_ms=1462878398034,
|
|
2114
|
+
)
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
asyncio.run(main())
|
|
2118
|
+
"""
|
|
2119
|
+
_response = await self._raw_client.v_1_get_machines_history(
|
|
2120
|
+
end_ms=end_ms, start_ms=start_ms, request_options=request_options
|
|
2121
|
+
)
|
|
2122
|
+
return _response.data
|
|
2123
|
+
|
|
2124
|
+
async def v_1_get_machines(self, *, request_options: typing.Optional[RequestOptions] = None) -> InlineResponse2008:
|
|
2125
|
+
"""
|
|
2126
|
+
<n class="warning">
|
|
2127
|
+
<nh>
|
|
2128
|
+
<i class="fa fa-exclamation-circle"></i>
|
|
2129
|
+
This endpoint is still on our legacy API.
|
|
2130
|
+
</nh>
|
|
2131
|
+
</n>
|
|
2132
|
+
|
|
2133
|
+
Get machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them.
|
|
2134
|
+
|
|
2135
|
+
**Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
|
|
2136
|
+
|
|
2137
|
+
To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
|
|
2138
|
+
|
|
2139
|
+
Parameters
|
|
2140
|
+
----------
|
|
2141
|
+
request_options : typing.Optional[RequestOptions]
|
|
2142
|
+
Request-specific configuration.
|
|
2143
|
+
|
|
2144
|
+
Returns
|
|
2145
|
+
-------
|
|
2146
|
+
InlineResponse2008
|
|
2147
|
+
List of machine objects.
|
|
2148
|
+
|
|
2149
|
+
Examples
|
|
2150
|
+
--------
|
|
2151
|
+
import asyncio
|
|
2152
|
+
|
|
2153
|
+
from samsara import AsyncSamsara
|
|
2154
|
+
|
|
2155
|
+
client = AsyncSamsara(
|
|
2156
|
+
token="YOUR_TOKEN",
|
|
2157
|
+
)
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
async def main() -> None:
|
|
2161
|
+
await client.industrial.v_1_get_machines()
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
asyncio.run(main())
|
|
2165
|
+
"""
|
|
2166
|
+
_response = await self._raw_client.v_1_get_machines(request_options=request_options)
|
|
2167
|
+
return _response.data
|