samsara_api 0.0.228

data/lib/samsara_api/equipment/stats/client.rb

@@ -0,0 +1,572 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "types/stats_list_request_types_item"
+require_relative "../../types/equipment_stats_response"
+require_relative "types/stats_feed_request_types_item"
+require_relative "../../types/equipment_stats_list_response"
+require_relative "types/stats_history_request_types_item"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Samsara
+  module Equipment
+    class StatsClient
+    # @return [Samsara::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Samsara::RequestClient] 
+      # @return [Samsara::Equipment::StatsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns the last known stats for all equipment. This can be optionally filtered
+#  by tags or specific equipment IDs.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsListRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.list
+      def list(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats"
+end
+        Samsara::Types::EquipmentStatsResponse.from_json(json_object: response.body)
+      end
+# Follow a continuous feed of all equipment stats.
+#  Your first call to this endpoint will provide you with the most recent stats for
+#  each unit of equipment and a `pagination` object that contains an `endCursor`.
+#  You can provide the `endCursor` to subsequent calls via the `after` parameter.
+#  The response will contain any equipment stats updates since that `endCursor`.
+#  If `hasNextPage` is `false`, no updates are readily available yet. Each stat
+#  type has a different refresh rate, but in general we'd suggest waiting a minimum
+#  of 5 seconds before requesting updates.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsFeedRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsListResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.feed
+      def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats/feed"
+end
+        Samsara::Types::EquipmentStatsListResponse.from_json(json_object: response.body)
+      end
+# Returns historical equipment status during the given time range. This can be
+#  optionally filtered by tags or specific equipment IDs.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param start_time [String] 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).
+      # @param end_time [String] 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).
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsHistoryRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsListResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.history(start_time: "startTime", end_time: "endTime")
+      def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats/history"
+end
+        Samsara::Types::EquipmentStatsListResponse.from_json(json_object: response.body)
+      end
+    end
+    class AsyncStatsClient
+    # @return [Samsara::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Samsara::RequestClient] 
+      # @return [Samsara::Equipment::AsyncStatsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns the last known stats for all equipment. This can be optionally filtered
+#  by tags or specific equipment IDs.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsListRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.list
+      def list(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats"
+end
+          Samsara::Types::EquipmentStatsResponse.from_json(json_object: response.body)
+        end
+      end
+# Follow a continuous feed of all equipment stats.
+#  Your first call to this endpoint will provide you with the most recent stats for
+#  each unit of equipment and a `pagination` object that contains an `endCursor`.
+#  You can provide the `endCursor` to subsequent calls via the `after` parameter.
+#  The response will contain any equipment stats updates since that `endCursor`.
+#  If `hasNextPage` is `false`, no updates are readily available yet. Each stat
+#  type has a different refresh rate, but in general we'd suggest waiting a minimum
+#  of 5 seconds before requesting updates.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsFeedRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsListResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.feed
+      def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats/feed"
+end
+          Samsara::Types::EquipmentStatsListResponse.from_json(json_object: response.body)
+        end
+      end
+# Returns historical equipment status during the given time range. This can be
+#  optionally filtered by tags or specific equipment IDs.
+#  <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  **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.
+#  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>
+      #
+      # @param after [String] 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.
+      # @param start_time [String] 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).
+      # @param end_time [String] 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).
+      # @param parent_tag_ids [String] 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`
+      # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+      # @param equipment_ids [String] A filter on the data based on this comma-separated list of equipment IDs.
+#  Example: `equipmentIds=1234,5678`
+      # @param types [Samsara::Equipment::Stats::Types::StatsHistoryRequestTypesItem] The types of equipment stats you want to query. Currently, you may submit up to
+#  4 types.
+#  - `engineRpm`: The revolutions per minute of the engine.
+#  - `fuelPercents`: The percent of fuel in the unit of equipment.
+#  - `obdEngineSeconds`: The number of seconds the engine has been running as
+#  reported directly from on-board diagnostics. This is supported with the
+#  following hardware configurations: AG24/AG26 + AOPEN/A9PIN/ACT9/ACT14.
+#  - `gatewayEngineSeconds`: An approximation of the number of seconds the engine
+#  has been running since it was new, based on the amount of time the asset gateway
+#  has been receiving power with an offset provided manually through the Samsara
+#  cloud dashboard. This is supported with the following hardware configurations:
+#  - AG24/AG26/AG46P + APWR cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required)
+#  - AG52 + BPWR/BEQP cable ([Auxiliary engine
+#  rticles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d)
+#  required).
+#  - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the
+#  engine has been running since it was new, based on the amount of time the AG26
+#  device is receiving power via J1939/CAT cable and an offset provided manually
+#  through the Samsara cloud dashboard.
+#  - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can
+#  be `Off`, `On`, or `Idle`.
+#  - `gatewayEngineStates`: An approximation of engine state based on readings the
+#  AG26 receives from the aux/digio cable. Can be `Off` or `On`.
+#  - `gpsOdometerMeters`: An approximation of odometer reading based on GPS
+#  calculations since the AG26 was activated, and a manual odometer offset provided
+#  in the Samsara cloud dashboard. Valid values: `Off`, `On`.
+#  - `gps`: GPS data including lat/long, heading, speed, address book entry (if
+#  exists), and a reverse geocoded address.
+#  - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been
+#  idling.
+      # @param request_options [Samsara::RequestOptions] 
+      # @return [Samsara::Types::EquipmentStatsListResponse]
+      # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.equipment.stats.history(start_time: "startTime", end_time: "endTime")
+      def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, equipment_ids: nil, types: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "after": after, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "equipmentIds": equipment_ids, "types": types }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/equipment/stats/history"
+end
+          Samsara::Types::EquipmentStatsListResponse.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/samsara_api/equipment/stats/types/stats_feed_request_types_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Samsara
+  module Equipment
+    module Stats
+      module Types
+        class StatsFeedRequestTypesItem
+
+          GATEWAY_ENGINE_STATES = "gatewayEngineStates"
+          OBD_ENGINE_STATES = "obdEngineStates"
+          FUEL_PERCENTS = "fuelPercents"
+          ENGINE_RPM = "engineRpm"
+          GATEWAY_ENGINE_SECONDS = "gatewayEngineSeconds"
+          OBD_ENGINE_SECONDS = "obdEngineSeconds"
+          GATEWAY_J_1939_ENGINE_SECONDS = "gatewayJ1939EngineSeconds"
+          GPS_ODOMETER_METERS = "gpsOdometerMeters"
+          GPS = "gps"
+          ENGINE_TOTAL_IDLE_TIME_MINUTES = "engineTotalIdleTimeMinutes"
+
+        end
+      end
+    end
+  end
+end

data/lib/samsara_api/equipment/stats/types/stats_history_request_types_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Samsara
+  module Equipment
+    module Stats
+      module Types
+        class StatsHistoryRequestTypesItem
+
+          GATEWAY_ENGINE_STATES = "gatewayEngineStates"
+          OBD_ENGINE_STATES = "obdEngineStates"
+          FUEL_PERCENTS = "fuelPercents"
+          ENGINE_RPM = "engineRpm"
+          GATEWAY_ENGINE_SECONDS = "gatewayEngineSeconds"
+          OBD_ENGINE_SECONDS = "obdEngineSeconds"
+          GATEWAY_J_1939_ENGINE_SECONDS = "gatewayJ1939EngineSeconds"
+          GPS_ODOMETER_METERS = "gpsOdometerMeters"
+          GPS = "gps"
+          ENGINE_TOTAL_IDLE_TIME_MINUTES = "engineTotalIdleTimeMinutes"
+
+        end
+      end
+    end
+  end
+end

data/lib/samsara_api/equipment/stats/types/stats_list_request_types_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Samsara
+  module Equipment
+    module Stats
+      module Types
+        class StatsListRequestTypesItem
+
+          GATEWAY_ENGINE_STATES = "gatewayEngineStates"
+          OBD_ENGINE_STATES = "obdEngineStates"
+          FUEL_PERCENTS = "fuelPercents"
+          ENGINE_RPM = "engineRpm"
+          GATEWAY_ENGINE_SECONDS = "gatewayEngineSeconds"
+          OBD_ENGINE_SECONDS = "obdEngineSeconds"
+          GATEWAY_J_1939_ENGINE_SECONDS = "gatewayJ1939EngineSeconds"
+          GPS_ODOMETER_METERS = "gpsOdometerMeters"
+          GPS = "gps"
+          ENGINE_TOTAL_IDLE_TIME_MINUTES = "engineTotalIdleTimeMinutes"
+
+        end
+      end
+    end
+  end
+end