samsara_api 0.0.228

data/lib/samsara_api/hos/client.rb

@@ -0,0 +1,599 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/hos_clocks_response"
+require_relative "types/hos_daily_logs_request_driver_activation_status"
+require_relative "../types/hos_daily_logs_get_hos_daily_logs_response_body"
+require_relative "../types/hos_logs_response"
+require_relative "../types/hos_violations_get_hos_violations_response_body"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Samsara
+  class HosClient
+  # @return [Samsara::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Samsara::RequestClient] 
+    # @return [Samsara::HosClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Get the current HOS status for all drivers. Note that this includes inactive as
+#  well as active drivers. The legacy version of this endpoint can be found at
+#  pi-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogsSummary).
+#  **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 ELD Compliance Settings (US)** under the
+#  Compliance 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_ids [String] A filter on the data based on this comma-separated list of driver IDs. Example:
+#  `driverIds=1234,5678`
+    # @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 limit [Long] The limit for how many objects will be in the response. Default and max for this
+#  value is 512 objects.
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosClocksResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.clocks
+    def clocks(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, after: nil, limit: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "after": after, "limit": limit }.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/hos/clocks"
+end
+      Samsara::Types::HosClocksResponse.from_json(json_object: response.body)
+    end
+# Get summarized daily Hours of Service charts for the specified drivers.
+#  The time range for a log is defined by the `driver`'s `eldDayStartHour`. This
+#  value is configurable per driver.
+#  The `startDate` and `endDate` parameters indicate the date range you'd like to
+#  retrieve daily logs for. A daily log will be returned if its `startTime` is on
+#  any of the days within in this date range (inclusive of `startDate` and
+#  `endDate`).
+#  **Note:** If data is still being uploaded from the Samsara Driver App, it may
+#  not be completely reflected in the response from this endpoint. The best
+#  practice is to wait a couple of days before querying this endpoint to make sure
+#  that all data from the Samsara Driver App has been uploaded.
+#  If you are using the legacy version of this endpoint and looking for its
+#  documentation, you can find it
+#  here](https://www.samsara.com/api-legacy#operation/getFleetDriversHosDailyLogs).
+#  <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  To use this endpoint, select **Read ELD Compliance Settings (US)** under the
+#  Compliance 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>
+#  **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.
+    #
+    # @param driver_ids [String] A filter on the data based on this comma-separated list of driver IDs and
+#  externalIds. Example: `driverIds=1234,5678,payroll:4841`
+    # @param start_date [String] A start date in YYYY-MM-DD. This is a date only without an associated time.
+#  Example: `2019-06-13`. This is a required field
+    # @param end_date [String] An end date in YYYY-MM-DD. This is a date only without an associated time. Must
+#  be greater than or equal to the start date. Example: `2019-07-21`. This is a
+#  required field
+    # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_activation_status [Samsara::Hos::Types::HosDailyLogsRequestDriverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the
+#  response. This parameter will default to `active` if not provided (fetching only
+#  active drivers).  Valid values: `active`, `deactivated`
+    # @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 expand [String] Expands the specified value(s) in the response object. Expansion populates
+#  additional fields in an object, if supported. Unsupported fields are ignored. To
+#  expand multiple fields, input a comma-separated list.
+#  Valid value: `vehicle`  Valid values: `vehicle`
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosDailyLogsGetHosDailyLogsResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.daily_logs
+    def daily_logs(driver_ids: nil, start_date: nil, end_date: nil, tag_ids: nil, parent_tag_ids: nil, driver_activation_status: nil, after: nil, expand: 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 || {}), "driverIds": driver_ids, "startDate": start_date, "endDate": end_date, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverActivationStatus": driver_activation_status, "after": after, "expand": expand }.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/hos/daily-logs"
+end
+      Samsara::Types::HosDailyLogsGetHosDailyLogsResponseBody.from_json(json_object: response.body)
+    end
+# Returns HOS logs between a given `startTime` and `endTime`. The logs can be
+#  further filtered using tags or by providing a list of driver IDs (including
+#  external IDs). The legacy version of this endpoint can be found at
+#  a.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogs).
+#  **Note:** If data is still being uploaded from the Samsara Driver App, it may
+#  not be completely reflected in the response from this endpoint. The best
+#  practice is to wait a couple of days before querying this endpoint to make sure
+#  that all data from the Samsara Driver App has been uploaded.
+#  <b>Rate limit:</b> 5 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 ELD Compliance Settings (US)** under the
+#  Compliance 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_ids [String] A filter on the data based on this comma-separated list of driver IDs. Example:
+#  `driverIds=1234,5678`
+    # @param start_time [String] A start time in RFC 3339 format. Defaults to now if not provided. 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. Defaults to now if not provided. 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 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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosLogsResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.logs
+    def logs(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, start_time: nil, end_time: nil, after: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "after": after }.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/hos/logs"
+end
+      Samsara::Types::HosLogsResponse.from_json(json_object: response.body)
+    end
+# Get active Hours of Service violations for the specified drivers.
+#  The day object time range for a violation is defined by the `driver`'s
+#  `eldDayStartHour`. This value is configurable per driver.
+#  The `startTime` and `endTime` parameters indicate the datetime range you'd like
+#  to retrieve violations for. A violation will be returned if its
+#  `violationStartTime` falls within this datetime range (inclusive of `startTime`
+#  and `endTime`)
+#  **Note:** The following are all the violation types with a short explanation
+#  about what each of them means: `californiaMealbreakMissed` (Missed California
+#  Meal Break), `cycleHoursOn` (Cycle Limit), `cycleOffHoursAfterOnDutyHours`
+#  (Cycle 2 Limit), `dailyDrivingHours` (Daily Driving Limit),
+#  `dailyOffDutyDeferralAddToDay2Consecutive` (Daily Off-Duty Deferral: Add To Day2
+#  Consecutive), `dailyOffDutyDeferralNotPartMandatory` (Daily Off-Duty Deferral:
+#  Not Part Of Mandatory), `dailyOffDutyDeferralTwoDayDrivingLimit` (Daily Off-Duty
+#  Deferral: 2 Day Driving Limit), `dailyOffDutyDeferralTwoDayOffDuty` (Daily
+#  Off-Duty Deferral: 2 Day Off Duty), `dailyOffDutyNonResetHours` (Daily Off-Duty
+#  Time: Non-Reset), `dailyOffDutyTotalHours` (Daily Off-Duty Time),
+#  `dailyOnDutyHours` (Daily On-Duty Limit), `mandatory24HoursOffDuty` (24 Hours of
+#  Off Duty required), `restbreakMissed` (Missed Rest Break), `shiftDrivingHours`
+#  (Shift Driving Limit), `shiftHours` (Shift Duty Limit), `shiftOnDutyHours`
+#  (Shift On-Duty Limit), `unsubmittedLogs` (Missing Driver Certification)
+#  <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  To use this endpoint, select **Read ELD Compliance Settings (US)** under the
+#  Compliance 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>
+#  **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.
+    #
+    # @param driver_ids [String] A filter on the data based on this comma-separated list of driver IDs and
+#  externalIds. Example: `driverIds=1234,5678,payroll:4841`
+    # @param start_time [String] A start time in RFC 3339 format. Defaults to now if not provided. 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. Defaults to now if not provided. 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 types [String] A filter on violations data based on the violation type enum. Supported types:
+#  `NONE, californiaMealbreakMissed, cycleHoursOn, cycleOffHoursAfterOnDutyHours,
+#  dailyDrivingHours, dailyOffDutyDeferralAddToDay2Consecutive,
+#  dailyOffDutyDeferralNotPartMandatory, dailyOffDutyDeferralTwoDayDrivingLimit,
+#  dailyOffDutyDeferralTwoDayOffDuty, dailyOffDutyNonResetHours,
+#  dailyOffDutyTotalHours, dailyOnDutyHours, mandatory24HoursOffDuty,
+#  restbreakMissed, shiftDrivingHours, shiftHours, shiftOnDutyHours,
+#  unsubmittedLogs`
+    # @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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosViolationsGetHosViolationsResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.violations
+    def violations(driver_ids: nil, start_time: nil, end_time: nil, tag_ids: nil, parent_tag_ids: nil, types: nil, after: 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 || {}), "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "types": types, "after": after }.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/hos/violations"
+end
+      Samsara::Types::HosViolationsGetHosViolationsResponseBody.from_json(json_object: response.body)
+    end
+  end
+  class AsyncHosClient
+  # @return [Samsara::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Samsara::RequestClient] 
+    # @return [Samsara::AsyncHosClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Get the current HOS status for all drivers. Note that this includes inactive as
+#  well as active drivers. The legacy version of this endpoint can be found at
+#  pi-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogsSummary).
+#  **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 ELD Compliance Settings (US)** under the
+#  Compliance 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_ids [String] A filter on the data based on this comma-separated list of driver IDs. Example:
+#  `driverIds=1234,5678`
+    # @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 limit [Long] The limit for how many objects will be in the response. Default and max for this
+#  value is 512 objects.
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosClocksResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.clocks
+    def clocks(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, after: nil, limit: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "after": after, "limit": limit }.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/hos/clocks"
+end
+        Samsara::Types::HosClocksResponse.from_json(json_object: response.body)
+      end
+    end
+# Get summarized daily Hours of Service charts for the specified drivers.
+#  The time range for a log is defined by the `driver`'s `eldDayStartHour`. This
+#  value is configurable per driver.
+#  The `startDate` and `endDate` parameters indicate the date range you'd like to
+#  retrieve daily logs for. A daily log will be returned if its `startTime` is on
+#  any of the days within in this date range (inclusive of `startDate` and
+#  `endDate`).
+#  **Note:** If data is still being uploaded from the Samsara Driver App, it may
+#  not be completely reflected in the response from this endpoint. The best
+#  practice is to wait a couple of days before querying this endpoint to make sure
+#  that all data from the Samsara Driver App has been uploaded.
+#  If you are using the legacy version of this endpoint and looking for its
+#  documentation, you can find it
+#  here](https://www.samsara.com/api-legacy#operation/getFleetDriversHosDailyLogs).
+#  <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  To use this endpoint, select **Read ELD Compliance Settings (US)** under the
+#  Compliance 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>
+#  **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.
+    #
+    # @param driver_ids [String] A filter on the data based on this comma-separated list of driver IDs and
+#  externalIds. Example: `driverIds=1234,5678,payroll:4841`
+    # @param start_date [String] A start date in YYYY-MM-DD. This is a date only without an associated time.
+#  Example: `2019-06-13`. This is a required field
+    # @param end_date [String] An end date in YYYY-MM-DD. This is a date only without an associated time. Must
+#  be greater than or equal to the start date. Example: `2019-07-21`. This is a
+#  required field
+    # @param tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_activation_status [Samsara::Hos::Types::HosDailyLogsRequestDriverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the
+#  response. This parameter will default to `active` if not provided (fetching only
+#  active drivers).  Valid values: `active`, `deactivated`
+    # @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 expand [String] Expands the specified value(s) in the response object. Expansion populates
+#  additional fields in an object, if supported. Unsupported fields are ignored. To
+#  expand multiple fields, input a comma-separated list.
+#  Valid value: `vehicle`  Valid values: `vehicle`
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosDailyLogsGetHosDailyLogsResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.daily_logs
+    def daily_logs(driver_ids: nil, start_date: nil, end_date: nil, tag_ids: nil, parent_tag_ids: nil, driver_activation_status: nil, after: nil, expand: 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 || {}), "driverIds": driver_ids, "startDate": start_date, "endDate": end_date, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverActivationStatus": driver_activation_status, "after": after, "expand": expand }.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/hos/daily-logs"
+end
+        Samsara::Types::HosDailyLogsGetHosDailyLogsResponseBody.from_json(json_object: response.body)
+      end
+    end
+# Returns HOS logs between a given `startTime` and `endTime`. The logs can be
+#  further filtered using tags or by providing a list of driver IDs (including
+#  external IDs). The legacy version of this endpoint can be found at
+#  a.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogs).
+#  **Note:** If data is still being uploaded from the Samsara Driver App, it may
+#  not be completely reflected in the response from this endpoint. The best
+#  practice is to wait a couple of days before querying this endpoint to make sure
+#  that all data from the Samsara Driver App has been uploaded.
+#  <b>Rate limit:</b> 5 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 ELD Compliance Settings (US)** under the
+#  Compliance 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 driver_ids [String] A filter on the data based on this comma-separated list of driver IDs. Example:
+#  `driverIds=1234,5678`
+    # @param start_time [String] A start time in RFC 3339 format. Defaults to now if not provided. 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. Defaults to now if not provided. 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 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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosLogsResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.logs
+    def logs(tag_ids: nil, parent_tag_ids: nil, driver_ids: nil, start_time: nil, end_time: nil, after: 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 || {}), "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "after": after }.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/hos/logs"
+end
+        Samsara::Types::HosLogsResponse.from_json(json_object: response.body)
+      end
+    end
+# Get active Hours of Service violations for the specified drivers.
+#  The day object time range for a violation is defined by the `driver`'s
+#  `eldDayStartHour`. This value is configurable per driver.
+#  The `startTime` and `endTime` parameters indicate the datetime range you'd like
+#  to retrieve violations for. A violation will be returned if its
+#  `violationStartTime` falls within this datetime range (inclusive of `startTime`
+#  and `endTime`)
+#  **Note:** The following are all the violation types with a short explanation
+#  about what each of them means: `californiaMealbreakMissed` (Missed California
+#  Meal Break), `cycleHoursOn` (Cycle Limit), `cycleOffHoursAfterOnDutyHours`
+#  (Cycle 2 Limit), `dailyDrivingHours` (Daily Driving Limit),
+#  `dailyOffDutyDeferralAddToDay2Consecutive` (Daily Off-Duty Deferral: Add To Day2
+#  Consecutive), `dailyOffDutyDeferralNotPartMandatory` (Daily Off-Duty Deferral:
+#  Not Part Of Mandatory), `dailyOffDutyDeferralTwoDayDrivingLimit` (Daily Off-Duty
+#  Deferral: 2 Day Driving Limit), `dailyOffDutyDeferralTwoDayOffDuty` (Daily
+#  Off-Duty Deferral: 2 Day Off Duty), `dailyOffDutyNonResetHours` (Daily Off-Duty
+#  Time: Non-Reset), `dailyOffDutyTotalHours` (Daily Off-Duty Time),
+#  `dailyOnDutyHours` (Daily On-Duty Limit), `mandatory24HoursOffDuty` (24 Hours of
+#  Off Duty required), `restbreakMissed` (Missed Rest Break), `shiftDrivingHours`
+#  (Shift Driving Limit), `shiftHours` (Shift Duty Limit), `shiftOnDutyHours`
+#  (Shift On-Duty Limit), `unsubmittedLogs` (Missing Driver Certification)
+#  <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a
+#  href="https://developers.samsara.com/docs/rate-limits"
+#  target="_blank">here</a>).
+#  To use this endpoint, select **Read ELD Compliance Settings (US)** under the
+#  Compliance 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>
+#  **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.
+    #
+    # @param driver_ids [String] A filter on the data based on this comma-separated list of driver IDs and
+#  externalIds. Example: `driverIds=1234,5678,payroll:4841`
+    # @param start_time [String] A start time in RFC 3339 format. Defaults to now if not provided. 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. Defaults to now if not provided. 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 tag_ids [String] A filter on the data based on this comma-separated list of tag IDs. Example:
+#  `tagIds=1234,5678`
+    # @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 types [String] A filter on violations data based on the violation type enum. Supported types:
+#  `NONE, californiaMealbreakMissed, cycleHoursOn, cycleOffHoursAfterOnDutyHours,
+#  dailyDrivingHours, dailyOffDutyDeferralAddToDay2Consecutive,
+#  dailyOffDutyDeferralNotPartMandatory, dailyOffDutyDeferralTwoDayDrivingLimit,
+#  dailyOffDutyDeferralTwoDayOffDuty, dailyOffDutyNonResetHours,
+#  dailyOffDutyTotalHours, dailyOnDutyHours, mandatory24HoursOffDuty,
+#  restbreakMissed, shiftDrivingHours, shiftHours, shiftOnDutyHours,
+#  unsubmittedLogs`
+    # @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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::HosViolationsGetHosViolationsResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.hos.violations
+    def violations(driver_ids: nil, start_time: nil, end_time: nil, tag_ids: nil, parent_tag_ids: nil, types: nil, after: 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 || {}), "driverIds": driver_ids, "startTime": start_time, "endTime": end_time, "tagIds": tag_ids, "parentTagIds": parent_tag_ids, "types": types, "after": after }.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/hos/violations"
+end
+        Samsara::Types::HosViolationsGetHosViolationsResponseBody.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/samsara_api/hos/types/hos_daily_logs_request_driver_activation_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Samsara
+  module Hos
+    module Types
+      class HosDailyLogsRequestDriverActivationStatus
+
+        ACTIVE = "active"
+        DEACTIVATED = "deactivated"
+
+      end
+    end
+  end
+end