Class: Samsara::Alerts::ConfigurationsClient

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::ConfigurationsClient

Parameters:



26
27
28
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 26

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



21
22
23
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 21

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

)



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 345

def create(actions:, external_ids: nil, is_enabled:, name:, operational_settings: nil, scope:, triggers:, 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 || {}), 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

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

api.alerts.configurations.delete(id: "id")



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 387

def delete(id:, request_options: nil)
  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

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

api.alerts.configurations.list



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 104

def list(ids: nil, status: nil, after: nil, include_external_ids: 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 || {}), "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

#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")



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/samsara_api/alerts/configurations/client.rb', line 622

def update(actions: nil, external_ids: nil, id:, is_enabled: nil, name: nil, operational_settings: nil, scope: nil, triggers: 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 || {}), 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