Class: Samsara::Alerts::AsyncConfigurationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/alerts/configurations/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::Alerts::AsyncConfigurationsClient

Parameters:



647
648
649
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 647

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



642
643
644
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 642

def request_client
  @request_client
end

Instance Method Details

#create(actions:, external_ids: nil, is_enabled:, name:, operational_settings: nil, scope:, triggers:, request_options: nil) ⇒ Object

)



968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 968

def create(actions:, external_ids: nil, is_enabled:, name:, operational_settings: nil, scope:, triggers:, 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 || {}), actions: actions, externalIds: external_ids, isEnabled: is_enabled, name: name, operationalSettings: operational_settings, scope: scope, triggers: triggers }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/alerts/configurations"
end
    Samsara::Types::AlertsPostConfigurationsResponseBody.from_json(json_object: response.body)
  end
end

#delete(id:, request_options: nil) ⇒ Object

api.alerts.configurations.delete(id: “id”)



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 1012

def delete(id:, request_options: nil)
  Async do
    response = @request_client.conn.delete 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 || {}), "id": id }.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)}/alerts/configurations"
end
  end
end

#list(ids: nil, status: nil, after: nil, include_external_ids: nil, request_options: nil) ⇒ Object

api.alerts.configurations.list



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 725

def list(ids: nil, status: nil, after: nil, include_external_ids: 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 || {}), "ids": ids, "status": status, "after": after, "includeExternalIds": include_external_ids }.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)}/alerts/configurations"
end
    Samsara::Types::AlertsGetConfigurationsResponseBody.from_json(json_object: response.body)
  end
end

#update(actions: nil, external_ids: nil, id:, is_enabled: nil, name: nil, operational_settings: nil, scope: nil, triggers: nil, request_options: nil) ⇒ Object

api.alerts.configurations.update(id: “e1c5dffc-c7b7-47b0-a778-6a65de638abf”)



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 1249

def update(actions: nil, external_ids: nil, id:, is_enabled: nil, name: nil, operational_settings: nil, scope: nil, triggers: 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 || {}), actions: actions, externalIds: external_ids, id: id, isEnabled: is_enabled, name: name, operationalSettings: operational_settings, scope: scope, triggers: triggers }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/alerts/configurations"
end
    Samsara::Types::AlertsPatchConfigurationsResponseBody.from_json(json_object: response.body)
  end
end