samsara_api 0.0.228

data/lib/samsara_api/drivers/client.rb

@@ -0,0 +1,821 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "qr_codes/client"
+require_relative "vehicle_assignments/client"
+require_relative "types/drivers_list_request_driver_activation_status"
+require_relative "../types/list_drivers_response"
+require_relative "../types/create_driver_request_attributes"
+require_relative "../types/driver_carrier_settings"
+require_relative "../types/driver_hos_setting"
+require_relative "types/create_driver_request_locale"
+require_relative "../types/us_driver_ruleset_override"
+require_relative "../types/driver_response"
+require_relative "../types/driver_remote_signout_post_driver_remote_signout_response_body"
+require_relative "types/update_driver_request_driver_activation_status"
+require_relative "../types/update_driver_request_hos_setting"
+require_relative "types/update_driver_request_locale"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Samsara
+  class DriversClient
+  # @return [Samsara::RequestClient] 
+    attr_reader :request_client
+  # @return [Samsara::Drivers::QrCodesClient] 
+    attr_reader :qr_codes
+  # @return [Samsara::Drivers::VehicleAssignmentsClient] 
+    attr_reader :vehicle_assignments
+
+
+    # @param request_client [Samsara::RequestClient] 
+    # @return [Samsara::DriversClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @qr_codes = Samsara::Drivers::QrCodesClient.new(request_client: request_client)
+      @vehicle_assignments = Samsara::Drivers::VehicleAssignmentsClient.new(request_client: request_client)
+    end
+# Get all drivers in organization.
+#  **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 Drivers** under the Drivers 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 driver_activation_status [Samsara::Drivers::Types::DriversListRequestDriverActivationStatus] 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).
+    # @param limit [Long] The limit for how many objects will be in the response. Default and max for this
+#  value is 512 objects.
+    # @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 attribute_value_ids [String] A filter on the data based on this comma-separated list of attribute value IDs.
+#  Only entities associated with ALL of the referenced values will be returned
+#  (i.e. the intersection of the sets of entities with each value). Example:
+#  ueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
+    # @param attributes [String] A filter on the data to return entities having given attributes using name-value
+#  pair, separated by semicolon. Only entities associated with ALL of the
+#  referenced values will be returned (i.e. the intersection of the sets of
+#  entities with each value). Example:
+#  `attributes=ExampleAttributeName:some_value&attributes=SomeOtherAttr:123`
+    # @param updated_after_time [String] A filter on data to have an updated at time after or equal to this specified
+#  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 created_after_time [String] A filter on data to have a created at time after or equal to this specified 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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::ListDriversResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.list
+    def list(driver_activation_status: nil, limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, attribute_value_ids: nil, attributes: nil, updated_after_time: nil, created_after_time: 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 || {}), "driverActivationStatus": driver_activation_status, "limit": limit, "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "attributeValueIds": attribute_value_ids, "attributes": attributes, "updatedAfterTime": updated_after_time, "createdAfterTime": created_after_time }.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/drivers"
+end
+      Samsara::Types::ListDriversResponse.from_json(json_object: response.body)
+    end
+# Add a driver to the organization.
+#  **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 **Write Drivers** under the Drivers 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 attributes [Array<Hash>] Request of type Array<Samsara::Types::CreateDriverRequestAttributes>, as a Hash
+    #   * :id (String) 
+    #   * :name (String) 
+    #   * :number_values (Array<Float>) 
+    #   * :string_values (Array<String>) 
+    # @param carrier_settings [Hash] Request of type Samsara::Types::DriverCarrierSettings, as a Hash
+    #   * :carrier_name (String) 
+    #   * :dot_number (Long) 
+    #   * :home_terminal_address (String) 
+    #   * :home_terminal_name (String) 
+    #   * :main_office_address (String) 
+    # @param current_id_card_code [String] The ID Card Code on the back of the physical card assigned to the driver.
+#  Contact Samsara if you would like to enable this feature.
+    # @param eld_adverse_weather_exemption_enabled [Boolean] Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
+    # @param eld_big_day_exemption_enabled [Boolean] Flag indicating this driver may use Big Day exemption in ELD logs.
+    # @param eld_day_start_hour [Integer] `0` indicating midnight-to-midnight ELD driving hours, `12` to indicate
+#  noon-to-noon driving hours.
+    # @param eld_exempt [Boolean] Flag indicating this driver is exempt from the Electronic Logging Mandate.
+    # @param eld_exempt_reason [String] Reason that this driver is exempt from the Electronic Logging Mandate (see
+#  eldExempt).
+    # @param eld_pc_enabled [Boolean] Flag indicating this driver may select the Personal Conveyance duty status in
+#  ELD logs.
+    # @param eld_ym_enabled [Boolean] Flag indicating this driver may select the Yard Move duty status in ELD logs.
+    # @param external_ids [Hash{String => String}] The [external IDs](https://developers.samsara.com/docs/external-ids) for the
+#  given object.
+    # @param has_driving_features_hidden [Boolean] 
+    # @param hos_setting [Hash] Request of type Samsara::Types::DriverHosSetting, as a Hash
+    #   * :heavy_haul_exemption_toggle_enabled (Boolean) 
+    # @param license_number [String] Driver's state issued license number. The combination of this number and
+#  `licenseState` must be unique.
+    # @param license_state [String] Abbreviation of US state, Canadian province, or US territory that issued
+#  driver's license.
+    # @param locale [Samsara::Drivers::Types::CreateDriverRequestLocale] Locale override (uncommon). These are specified by ISO 3166-2 country codes for
+#  supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`,
+#  `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.
+    # @param name [String] Driver's name.
+    # @param notes [String] Notes about the driver.
+    # @param password [String] Password that the driver can use to login to the Samsara driver app.
+    # @param peer_group_tag_id [String] The peer group tag id this driver belong to, used for gamification.
+    # @param phone [String] Phone number of the driver.
+    # @param static_assigned_vehicle_id [String] ID of vehicle that the driver is permanently assigned to. (uncommon).
+    # @param tachograph_card_number [String] Driver's assigned tachograph card number (Europe specific)
+    # @param tag_ids [Array<String>] IDs of tags the driver is associated with. If your access to the API is scoped
+#  by one or more tags, this field is required to pass in.
+    # @param timezone [String] Home terminal timezone, in order to indicate what time zone should be used to
+#  calculate the ELD logs. Driver timezones use [IANA timezone
+#  database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`,
+#  `America/New_York`, `Europe/London`, etc.). You can find a mapping of common
+#  timezone formats to IANA timezone keys
+#  [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).
+    # @param us_driver_ruleset_override [Hash] Request of type Samsara::Types::UsDriverRulesetOverride, as a Hash
+    #   * :cycle (Samsara::Types::UsDriverRulesetOverrideCycle) 
+    #   * :restart (Samsara::Types::UsDriverRulesetOverrideRestart) 
+    #   * :restbreak (Samsara::Types::UsDriverRulesetOverrideRestbreak) 
+    #   * :us_state_to_override (Samsara::Types::UsDriverRulesetOverrideUsStateToOverride) 
+    # @param username [String] Driver's login username into the driver app. The username may not contain spaces
+#  or the '@' symbol. The username must be unique.
+    # @param vehicle_group_tag_id [String] Tag ID which determines which vehicles a driver will see when selecting
+#  vehicles.
+    # @param waiting_time_duty_status_enabled [Boolean] Flag indicating this driver may select waiting time duty status in ELD logs
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.create(
+#    name: "Susan Jones",
+#    password: "aSecurePassword1234",
+#    username: "SusanJones"
+#  )
+    def create(attributes: nil, carrier_settings: nil, current_id_card_code: nil, eld_adverse_weather_exemption_enabled: nil, eld_big_day_exemption_enabled: nil, eld_day_start_hour: nil, eld_exempt: nil, eld_exempt_reason: nil, eld_pc_enabled: nil, eld_ym_enabled: nil, external_ids: nil, has_driving_features_hidden: nil, hos_setting: nil, license_number: nil, license_state: nil, locale: nil, name:, notes: nil, password:, peer_group_tag_id: nil, phone: nil, static_assigned_vehicle_id: nil, tachograph_card_number: nil, tag_ids: nil, timezone: nil, us_driver_ruleset_override: nil, username:, vehicle_group_tag_id: nil, waiting_time_duty_status_enabled: nil, request_options: nil)
+      response = @request_client.conn.post 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), attributes: attributes, carrierSettings: carrier_settings, currentIdCardCode: current_id_card_code, eldAdverseWeatherExemptionEnabled: eld_adverse_weather_exemption_enabled, eldBigDayExemptionEnabled: eld_big_day_exemption_enabled, eldDayStartHour: eld_day_start_hour, eldExempt: eld_exempt, eldExemptReason: eld_exempt_reason, eldPcEnabled: eld_pc_enabled, eldYmEnabled: eld_ym_enabled, externalIds: external_ids, hasDrivingFeaturesHidden: has_driving_features_hidden, hosSetting: hos_setting, licenseNumber: license_number, licenseState: license_state, locale: locale, name: name, notes: notes, password: password, peerGroupTagId: peer_group_tag_id, phone: phone, staticAssignedVehicleId: static_assigned_vehicle_id, tachographCardNumber: tachograph_card_number, tagIds: tag_ids, timezone: timezone, usDriverRulesetOverride: us_driver_ruleset_override, username: username, vehicleGroupTagId: vehicle_group_tag_id, waitingTimeDutyStatusEnabled: waiting_time_duty_status_enabled }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers"
+end
+      Samsara::Types::DriverResponse.from_json(json_object: response.body)
+    end
+# Sign out a driver from the Samsara Driver App
+#  To access this endpoint, your organization must have the Samsara Platform
+#  Premier license.
+#  Note: Sign out requests made while a logged-in driver does not have internet
+#  connection will not log the driver out. A success response will still be
+#  provided and the driver will be logged out once they have internet connection.
+#  <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>).
+#  To use this endpoint, select **Write Driver Remote Signout** under the Closed
+#  Beta 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_id [String] ID of the driver.
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverRemoteSignoutPostDriverRemoteSignoutResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.sign_out(driver_id: "12434")
+    def sign_out(driver_id:, request_options: nil)
+      response = @request_client.conn.post 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), driverId: driver_id }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers/remote-sign-out"
+end
+      Samsara::Types::DriverRemoteSignoutPostDriverRemoteSignoutResponseBody.from_json(json_object: response.body)
+    end
+# Get information about a driver.
+#  **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 Drivers** under the Drivers 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 id [String] ID of the driver. This can either be the Samsara-specified ID, or an external
+#  ID. External IDs are customer specified key-value pairs created in the POST or
+#  PATCH requests of this resource. To specify an external ID as part of a path
+#  parameter, use the following format: `key:value`. For example,
+#  `payrollId:ABFS18600`
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.get(id: "id")
+    def get(id:, 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  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/drivers/#{id}"
+end
+      Samsara::Types::DriverResponse.from_json(json_object: response.body)
+    end
+# Update a specific driver's information. This can also be used to activate or
+#  de-activate a given driver by setting the driverActivationStatus field. If the
+#  driverActivationStatus field is 'deactivated' then the user can also specify the
+#  deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the
+#  past and must not come before the dirver's latest active HOS log. It will be
+#  considered an error if deactivatedAtTime is provided with a
+#  driverActivationStatus of active.
+#  **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 **Write Drivers** under the Drivers 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 id [String] ID of the driver. This can either be the Samsara-specified ID, or an external
+#  ID. External IDs are customer specified key-value pairs created in the POST or
+#  PATCH requests of this resource. To specify an external ID as part of a path
+#  parameter, use the following format: `key:value`. For example,
+#  `payrollId:ABFS18600`
+    # @param attributes [Array<Hash>] Request of type Array<Samsara::Types::CreateDriverRequestAttributes>, as a Hash
+    #   * :id (String) 
+    #   * :name (String) 
+    #   * :number_values (Array<Float>) 
+    #   * :string_values (Array<String>) 
+    # @param carrier_settings [Hash] Request of type Samsara::Types::DriverCarrierSettings, as a Hash
+    #   * :carrier_name (String) 
+    #   * :dot_number (Long) 
+    #   * :home_terminal_address (String) 
+    #   * :home_terminal_name (String) 
+    #   * :main_office_address (String) 
+    # @param current_id_card_code [String] The ID Card Code on the back of the physical card assigned to the driver.
+#  Contact Samsara if you would like to enable this feature.
+    # @param deactivated_at_time [String] The date and time this driver is considered to be deactivated in RFC 3339
+#  format.
+    # @param driver_activation_status [Samsara::Drivers::Types::UpdateDriverRequestDriverActivationStatus] A value indicating whether the driver is active or deactivated. Valid values:
+#  `active`, `deactivated`.
+    # @param eld_adverse_weather_exemption_enabled [Boolean] Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
+    # @param eld_big_day_exemption_enabled [Boolean] Flag indicating this driver may use Big Day exemption in ELD logs.
+    # @param eld_day_start_hour [Integer] `0` indicating midnight-to-midnight ELD driving hours, `12` to indicate
+#  noon-to-noon driving hours.
+    # @param eld_exempt [Boolean] Flag indicating this driver is exempt from the Electronic Logging Mandate.
+    # @param eld_exempt_reason [String] Reason that this driver is exempt from the Electronic Logging Mandate (see
+#  eldExempt).
+    # @param eld_pc_enabled [Boolean] Flag indicating this driver may select the Personal Conveyance duty status in
+#  ELD logs.
+    # @param eld_ym_enabled [Boolean] Flag indicating this driver may select the Yard Move duty status in ELD logs.
+    # @param external_ids [Hash{String => String}] The [external IDs](https://developers.samsara.com/docs/external-ids) for the
+#  given object.
+    # @param has_driving_features_hidden [Boolean] 
+    # @param hos_setting [Hash] Request of type Samsara::Types::UpdateDriverRequestHosSetting, as a Hash
+    #   * :heavy_haul_exemption_toggle_enabled (Boolean) 
+    # @param license_number [String] Driver's state issued license number. The combination of this number and
+#  `licenseState` must be unique.
+    # @param license_state [String] Abbreviation of US state, Canadian province, or US territory that issued
+#  driver's license.
+    # @param locale [Samsara::Drivers::Types::UpdateDriverRequestLocale] Locale override (uncommon). These are specified by ISO 3166-2 country codes for
+#  supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`,
+#  `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.
+    # @param name [String] Driver's name.
+    # @param notes [String] Notes about the driver.
+    # @param password [String] Password that the driver can use to login to the Samsara driver app.
+    # @param peer_group_tag_id [String] The peer group tag id this driver belong to, leave blank to be in group with
+#  everyone, used for gamification.
+    # @param phone [String] Phone number of the driver.
+    # @param static_assigned_vehicle_id [String] ID of vehicle that the driver is permanently assigned to. (uncommon).
+    # @param tachograph_card_number [String] Driver's assigned tachograph card number (Europe specific)
+    # @param tag_ids [Array<String>] IDs of tags the driver is associated with. If your access to the API is scoped
+#  by one or more tags, this field is required to pass in.
+    # @param timezone [String] Home terminal timezone, in order to indicate what time zone should be used to
+#  calculate the ELD logs. Driver timezones use [IANA timezone
+#  database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`,
+#  `America/New_York`, `Europe/London`, etc.). You can find a mapping of common
+#  timezone formats to IANA timezone keys
+#  [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).
+    # @param us_driver_ruleset_override [Hash] Request of type Samsara::Types::UsDriverRulesetOverride, as a Hash
+    #   * :cycle (Samsara::Types::UsDriverRulesetOverrideCycle) 
+    #   * :restart (Samsara::Types::UsDriverRulesetOverrideRestart) 
+    #   * :restbreak (Samsara::Types::UsDriverRulesetOverrideRestbreak) 
+    #   * :us_state_to_override (Samsara::Types::UsDriverRulesetOverrideUsStateToOverride) 
+    # @param username [String] Driver's login username into the driver app. The username may not contain spaces
+#  or the '@' symbol. The username must be unique.
+    # @param vehicle_group_tag_id [String] Tag ID which determines which vehicles a driver will see when selecting
+#  vehicles.
+    # @param waiting_time_duty_status_enabled [Boolean] Flag indicating this driver may select waiting time duty status in ELD logs
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.update(id: "id")
+    def update(id:, attributes: nil, carrier_settings: nil, current_id_card_code: nil, deactivated_at_time: nil, driver_activation_status: nil, eld_adverse_weather_exemption_enabled: nil, eld_big_day_exemption_enabled: nil, eld_day_start_hour: nil, eld_exempt: nil, eld_exempt_reason: nil, eld_pc_enabled: nil, eld_ym_enabled: nil, external_ids: nil, has_driving_features_hidden: nil, hos_setting: nil, license_number: nil, license_state: nil, locale: nil, name: nil, notes: nil, password: nil, peer_group_tag_id: nil, phone: nil, static_assigned_vehicle_id: nil, tachograph_card_number: nil, tag_ids: nil, timezone: nil, us_driver_ruleset_override: nil, username: nil, vehicle_group_tag_id: nil, waiting_time_duty_status_enabled: nil, request_options: nil)
+      response = @request_client.conn.patch 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), attributes: attributes, carrierSettings: carrier_settings, currentIdCardCode: current_id_card_code, deactivatedAtTime: deactivated_at_time, driverActivationStatus: driver_activation_status, eldAdverseWeatherExemptionEnabled: eld_adverse_weather_exemption_enabled, eldBigDayExemptionEnabled: eld_big_day_exemption_enabled, eldDayStartHour: eld_day_start_hour, eldExempt: eld_exempt, eldExemptReason: eld_exempt_reason, eldPcEnabled: eld_pc_enabled, eldYmEnabled: eld_ym_enabled, externalIds: external_ids, hasDrivingFeaturesHidden: has_driving_features_hidden, hosSetting: hos_setting, licenseNumber: license_number, licenseState: license_state, locale: locale, name: name, notes: notes, password: password, peerGroupTagId: peer_group_tag_id, phone: phone, staticAssignedVehicleId: static_assigned_vehicle_id, tachographCardNumber: tachograph_card_number, tagIds: tag_ids, timezone: timezone, usDriverRulesetOverride: us_driver_ruleset_override, username: username, vehicleGroupTagId: vehicle_group_tag_id, waitingTimeDutyStatusEnabled: waiting_time_duty_status_enabled }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers/#{id}"
+end
+      Samsara::Types::DriverResponse.from_json(json_object: response.body)
+    end
+  end
+  class AsyncDriversClient
+  # @return [Samsara::AsyncRequestClient] 
+    attr_reader :request_client
+  # @return [Samsara::Drivers::QrCodesClient] 
+    attr_reader :qr_codes
+  # @return [Samsara::Drivers::VehicleAssignmentsClient] 
+    attr_reader :vehicle_assignments
+
+
+    # @param request_client [Samsara::RequestClient] 
+    # @return [Samsara::AsyncDriversClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @qr_codes = Samsara::Drivers::AsyncQrCodesClient.new(request_client: request_client)
+      @vehicle_assignments = Samsara::Drivers::AsyncVehicleAssignmentsClient.new(request_client: request_client)
+    end
+# Get all drivers in organization.
+#  **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 Drivers** under the Drivers 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 driver_activation_status [Samsara::Drivers::Types::DriversListRequestDriverActivationStatus] 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).
+    # @param limit [Long] The limit for how many objects will be in the response. Default and max for this
+#  value is 512 objects.
+    # @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 attribute_value_ids [String] A filter on the data based on this comma-separated list of attribute value IDs.
+#  Only entities associated with ALL of the referenced values will be returned
+#  (i.e. the intersection of the sets of entities with each value). Example:
+#  ueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
+    # @param attributes [String] A filter on the data to return entities having given attributes using name-value
+#  pair, separated by semicolon. Only entities associated with ALL of the
+#  referenced values will be returned (i.e. the intersection of the sets of
+#  entities with each value). Example:
+#  `attributes=ExampleAttributeName:some_value&attributes=SomeOtherAttr:123`
+    # @param updated_after_time [String] A filter on data to have an updated at time after or equal to this specified
+#  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 created_after_time [String] A filter on data to have a created at time after or equal to this specified 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 request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::ListDriversResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.list
+    def list(driver_activation_status: nil, limit: nil, after: nil, parent_tag_ids: nil, tag_ids: nil, attribute_value_ids: nil, attributes: nil, updated_after_time: nil, created_after_time: 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 || {}), "driverActivationStatus": driver_activation_status, "limit": limit, "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "attributeValueIds": attribute_value_ids, "attributes": attributes, "updatedAfterTime": updated_after_time, "createdAfterTime": created_after_time }.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/drivers"
+end
+        Samsara::Types::ListDriversResponse.from_json(json_object: response.body)
+      end
+    end
+# Add a driver to the organization.
+#  **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 **Write Drivers** under the Drivers 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 attributes [Array<Hash>] Request of type Array<Samsara::Types::CreateDriverRequestAttributes>, as a Hash
+    #   * :id (String) 
+    #   * :name (String) 
+    #   * :number_values (Array<Float>) 
+    #   * :string_values (Array<String>) 
+    # @param carrier_settings [Hash] Request of type Samsara::Types::DriverCarrierSettings, as a Hash
+    #   * :carrier_name (String) 
+    #   * :dot_number (Long) 
+    #   * :home_terminal_address (String) 
+    #   * :home_terminal_name (String) 
+    #   * :main_office_address (String) 
+    # @param current_id_card_code [String] The ID Card Code on the back of the physical card assigned to the driver.
+#  Contact Samsara if you would like to enable this feature.
+    # @param eld_adverse_weather_exemption_enabled [Boolean] Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
+    # @param eld_big_day_exemption_enabled [Boolean] Flag indicating this driver may use Big Day exemption in ELD logs.
+    # @param eld_day_start_hour [Integer] `0` indicating midnight-to-midnight ELD driving hours, `12` to indicate
+#  noon-to-noon driving hours.
+    # @param eld_exempt [Boolean] Flag indicating this driver is exempt from the Electronic Logging Mandate.
+    # @param eld_exempt_reason [String] Reason that this driver is exempt from the Electronic Logging Mandate (see
+#  eldExempt).
+    # @param eld_pc_enabled [Boolean] Flag indicating this driver may select the Personal Conveyance duty status in
+#  ELD logs.
+    # @param eld_ym_enabled [Boolean] Flag indicating this driver may select the Yard Move duty status in ELD logs.
+    # @param external_ids [Hash{String => String}] The [external IDs](https://developers.samsara.com/docs/external-ids) for the
+#  given object.
+    # @param has_driving_features_hidden [Boolean] 
+    # @param hos_setting [Hash] Request of type Samsara::Types::DriverHosSetting, as a Hash
+    #   * :heavy_haul_exemption_toggle_enabled (Boolean) 
+    # @param license_number [String] Driver's state issued license number. The combination of this number and
+#  `licenseState` must be unique.
+    # @param license_state [String] Abbreviation of US state, Canadian province, or US territory that issued
+#  driver's license.
+    # @param locale [Samsara::Drivers::Types::CreateDriverRequestLocale] Locale override (uncommon). These are specified by ISO 3166-2 country codes for
+#  supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`,
+#  `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.
+    # @param name [String] Driver's name.
+    # @param notes [String] Notes about the driver.
+    # @param password [String] Password that the driver can use to login to the Samsara driver app.
+    # @param peer_group_tag_id [String] The peer group tag id this driver belong to, used for gamification.
+    # @param phone [String] Phone number of the driver.
+    # @param static_assigned_vehicle_id [String] ID of vehicle that the driver is permanently assigned to. (uncommon).
+    # @param tachograph_card_number [String] Driver's assigned tachograph card number (Europe specific)
+    # @param tag_ids [Array<String>] IDs of tags the driver is associated with. If your access to the API is scoped
+#  by one or more tags, this field is required to pass in.
+    # @param timezone [String] Home terminal timezone, in order to indicate what time zone should be used to
+#  calculate the ELD logs. Driver timezones use [IANA timezone
+#  database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`,
+#  `America/New_York`, `Europe/London`, etc.). You can find a mapping of common
+#  timezone formats to IANA timezone keys
+#  [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).
+    # @param us_driver_ruleset_override [Hash] Request of type Samsara::Types::UsDriverRulesetOverride, as a Hash
+    #   * :cycle (Samsara::Types::UsDriverRulesetOverrideCycle) 
+    #   * :restart (Samsara::Types::UsDriverRulesetOverrideRestart) 
+    #   * :restbreak (Samsara::Types::UsDriverRulesetOverrideRestbreak) 
+    #   * :us_state_to_override (Samsara::Types::UsDriverRulesetOverrideUsStateToOverride) 
+    # @param username [String] Driver's login username into the driver app. The username may not contain spaces
+#  or the '@' symbol. The username must be unique.
+    # @param vehicle_group_tag_id [String] Tag ID which determines which vehicles a driver will see when selecting
+#  vehicles.
+    # @param waiting_time_duty_status_enabled [Boolean] Flag indicating this driver may select waiting time duty status in ELD logs
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.create(
+#    name: "Susan Jones",
+#    password: "aSecurePassword1234",
+#    username: "SusanJones"
+#  )
+    def create(attributes: nil, carrier_settings: nil, current_id_card_code: nil, eld_adverse_weather_exemption_enabled: nil, eld_big_day_exemption_enabled: nil, eld_day_start_hour: nil, eld_exempt: nil, eld_exempt_reason: nil, eld_pc_enabled: nil, eld_ym_enabled: nil, external_ids: nil, has_driving_features_hidden: nil, hos_setting: nil, license_number: nil, license_state: nil, locale: nil, name:, notes: nil, password:, peer_group_tag_id: nil, phone: nil, static_assigned_vehicle_id: nil, tachograph_card_number: nil, tag_ids: nil, timezone: nil, us_driver_ruleset_override: nil, username:, vehicle_group_tag_id: nil, waiting_time_duty_status_enabled: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), attributes: attributes, carrierSettings: carrier_settings, currentIdCardCode: current_id_card_code, eldAdverseWeatherExemptionEnabled: eld_adverse_weather_exemption_enabled, eldBigDayExemptionEnabled: eld_big_day_exemption_enabled, eldDayStartHour: eld_day_start_hour, eldExempt: eld_exempt, eldExemptReason: eld_exempt_reason, eldPcEnabled: eld_pc_enabled, eldYmEnabled: eld_ym_enabled, externalIds: external_ids, hasDrivingFeaturesHidden: has_driving_features_hidden, hosSetting: hos_setting, licenseNumber: license_number, licenseState: license_state, locale: locale, name: name, notes: notes, password: password, peerGroupTagId: peer_group_tag_id, phone: phone, staticAssignedVehicleId: static_assigned_vehicle_id, tachographCardNumber: tachograph_card_number, tagIds: tag_ids, timezone: timezone, usDriverRulesetOverride: us_driver_ruleset_override, username: username, vehicleGroupTagId: vehicle_group_tag_id, waitingTimeDutyStatusEnabled: waiting_time_duty_status_enabled }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers"
+end
+        Samsara::Types::DriverResponse.from_json(json_object: response.body)
+      end
+    end
+# Sign out a driver from the Samsara Driver App
+#  To access this endpoint, your organization must have the Samsara Platform
+#  Premier license.
+#  Note: Sign out requests made while a logged-in driver does not have internet
+#  connection will not log the driver out. A success response will still be
+#  provided and the driver will be logged out once they have internet connection.
+#  <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>).
+#  To use this endpoint, select **Write Driver Remote Signout** under the Closed
+#  Beta 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_id [String] ID of the driver.
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverRemoteSignoutPostDriverRemoteSignoutResponseBody]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.sign_out(driver_id: "12434")
+    def sign_out(driver_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.post 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), driverId: driver_id }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers/remote-sign-out"
+end
+        Samsara::Types::DriverRemoteSignoutPostDriverRemoteSignoutResponseBody.from_json(json_object: response.body)
+      end
+    end
+# Get information about a driver.
+#  **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 Drivers** under the Drivers 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 id [String] ID of the driver. This can either be the Samsara-specified ID, or an external
+#  ID. External IDs are customer specified key-value pairs created in the POST or
+#  PATCH requests of this resource. To specify an external ID as part of a path
+#  parameter, use the following format: `key:value`. For example,
+#  `payrollId:ABFS18600`
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.get(id: "id")
+    def get(id:, 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  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/drivers/#{id}"
+end
+        Samsara::Types::DriverResponse.from_json(json_object: response.body)
+      end
+    end
+# Update a specific driver's information. This can also be used to activate or
+#  de-activate a given driver by setting the driverActivationStatus field. If the
+#  driverActivationStatus field is 'deactivated' then the user can also specify the
+#  deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the
+#  past and must not come before the dirver's latest active HOS log. It will be
+#  considered an error if deactivatedAtTime is provided with a
+#  driverActivationStatus of active.
+#  **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 **Write Drivers** under the Drivers 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 id [String] ID of the driver. This can either be the Samsara-specified ID, or an external
+#  ID. External IDs are customer specified key-value pairs created in the POST or
+#  PATCH requests of this resource. To specify an external ID as part of a path
+#  parameter, use the following format: `key:value`. For example,
+#  `payrollId:ABFS18600`
+    # @param attributes [Array<Hash>] Request of type Array<Samsara::Types::CreateDriverRequestAttributes>, as a Hash
+    #   * :id (String) 
+    #   * :name (String) 
+    #   * :number_values (Array<Float>) 
+    #   * :string_values (Array<String>) 
+    # @param carrier_settings [Hash] Request of type Samsara::Types::DriverCarrierSettings, as a Hash
+    #   * :carrier_name (String) 
+    #   * :dot_number (Long) 
+    #   * :home_terminal_address (String) 
+    #   * :home_terminal_name (String) 
+    #   * :main_office_address (String) 
+    # @param current_id_card_code [String] The ID Card Code on the back of the physical card assigned to the driver.
+#  Contact Samsara if you would like to enable this feature.
+    # @param deactivated_at_time [String] The date and time this driver is considered to be deactivated in RFC 3339
+#  format.
+    # @param driver_activation_status [Samsara::Drivers::Types::UpdateDriverRequestDriverActivationStatus] A value indicating whether the driver is active or deactivated. Valid values:
+#  `active`, `deactivated`.
+    # @param eld_adverse_weather_exemption_enabled [Boolean] Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
+    # @param eld_big_day_exemption_enabled [Boolean] Flag indicating this driver may use Big Day exemption in ELD logs.
+    # @param eld_day_start_hour [Integer] `0` indicating midnight-to-midnight ELD driving hours, `12` to indicate
+#  noon-to-noon driving hours.
+    # @param eld_exempt [Boolean] Flag indicating this driver is exempt from the Electronic Logging Mandate.
+    # @param eld_exempt_reason [String] Reason that this driver is exempt from the Electronic Logging Mandate (see
+#  eldExempt).
+    # @param eld_pc_enabled [Boolean] Flag indicating this driver may select the Personal Conveyance duty status in
+#  ELD logs.
+    # @param eld_ym_enabled [Boolean] Flag indicating this driver may select the Yard Move duty status in ELD logs.
+    # @param external_ids [Hash{String => String}] The [external IDs](https://developers.samsara.com/docs/external-ids) for the
+#  given object.
+    # @param has_driving_features_hidden [Boolean] 
+    # @param hos_setting [Hash] Request of type Samsara::Types::UpdateDriverRequestHosSetting, as a Hash
+    #   * :heavy_haul_exemption_toggle_enabled (Boolean) 
+    # @param license_number [String] Driver's state issued license number. The combination of this number and
+#  `licenseState` must be unique.
+    # @param license_state [String] Abbreviation of US state, Canadian province, or US territory that issued
+#  driver's license.
+    # @param locale [Samsara::Drivers::Types::UpdateDriverRequestLocale] Locale override (uncommon). These are specified by ISO 3166-2 country codes for
+#  supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`,
+#  `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.
+    # @param name [String] Driver's name.
+    # @param notes [String] Notes about the driver.
+    # @param password [String] Password that the driver can use to login to the Samsara driver app.
+    # @param peer_group_tag_id [String] The peer group tag id this driver belong to, leave blank to be in group with
+#  everyone, used for gamification.
+    # @param phone [String] Phone number of the driver.
+    # @param static_assigned_vehicle_id [String] ID of vehicle that the driver is permanently assigned to. (uncommon).
+    # @param tachograph_card_number [String] Driver's assigned tachograph card number (Europe specific)
+    # @param tag_ids [Array<String>] IDs of tags the driver is associated with. If your access to the API is scoped
+#  by one or more tags, this field is required to pass in.
+    # @param timezone [String] Home terminal timezone, in order to indicate what time zone should be used to
+#  calculate the ELD logs. Driver timezones use [IANA timezone
+#  database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`,
+#  `America/New_York`, `Europe/London`, etc.). You can find a mapping of common
+#  timezone formats to IANA timezone keys
+#  [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).
+    # @param us_driver_ruleset_override [Hash] Request of type Samsara::Types::UsDriverRulesetOverride, as a Hash
+    #   * :cycle (Samsara::Types::UsDriverRulesetOverrideCycle) 
+    #   * :restart (Samsara::Types::UsDriverRulesetOverrideRestart) 
+    #   * :restbreak (Samsara::Types::UsDriverRulesetOverrideRestbreak) 
+    #   * :us_state_to_override (Samsara::Types::UsDriverRulesetOverrideUsStateToOverride) 
+    # @param username [String] Driver's login username into the driver app. The username may not contain spaces
+#  or the '@' symbol. The username must be unique.
+    # @param vehicle_group_tag_id [String] Tag ID which determines which vehicles a driver will see when selecting
+#  vehicles.
+    # @param waiting_time_duty_status_enabled [Boolean] Flag indicating this driver may select waiting time duty status in ELD logs
+    # @param request_options [Samsara::RequestOptions] 
+    # @return [Samsara::Types::DriverResponse]
+    # @example
+#  api = Samsara::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Samsara::Environment::PRODUCTION_API,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.drivers.update(id: "id")
+    def update(id:, attributes: nil, carrier_settings: nil, current_id_card_code: nil, deactivated_at_time: nil, driver_activation_status: nil, eld_adverse_weather_exemption_enabled: nil, eld_big_day_exemption_enabled: nil, eld_day_start_hour: nil, eld_exempt: nil, eld_exempt_reason: nil, eld_pc_enabled: nil, eld_ym_enabled: nil, external_ids: nil, has_driving_features_hidden: nil, hos_setting: nil, license_number: nil, license_state: nil, locale: nil, name: nil, notes: nil, password: nil, peer_group_tag_id: nil, phone: nil, static_assigned_vehicle_id: nil, tachograph_card_number: nil, tag_ids: nil, timezone: nil, us_driver_ruleset_override: nil, username: nil, vehicle_group_tag_id: nil, waiting_time_duty_status_enabled: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.patch 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
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), attributes: attributes, carrierSettings: carrier_settings, currentIdCardCode: current_id_card_code, deactivatedAtTime: deactivated_at_time, driverActivationStatus: driver_activation_status, eldAdverseWeatherExemptionEnabled: eld_adverse_weather_exemption_enabled, eldBigDayExemptionEnabled: eld_big_day_exemption_enabled, eldDayStartHour: eld_day_start_hour, eldExempt: eld_exempt, eldExemptReason: eld_exempt_reason, eldPcEnabled: eld_pc_enabled, eldYmEnabled: eld_ym_enabled, externalIds: external_ids, hasDrivingFeaturesHidden: has_driving_features_hidden, hosSetting: hos_setting, licenseNumber: license_number, licenseState: license_state, locale: locale, name: name, notes: notes, password: password, peerGroupTagId: peer_group_tag_id, phone: phone, staticAssignedVehicleId: static_assigned_vehicle_id, tachographCardNumber: tachograph_card_number, tagIds: tag_ids, timezone: timezone, usDriverRulesetOverride: us_driver_ruleset_override, username: username, vehicleGroupTagId: vehicle_group_tag_id, waitingTimeDutyStatusEnabled: waiting_time_duty_status_enabled }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/fleet/drivers/#{id}"
+end
+        Samsara::Types::DriverResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end