Class: Samsara::V1MessagesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::V1MessagesClient

Parameters:



17
18
19
# File 'lib/samsara_api/v_1_messages/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_clientSamsara::RequestClient (readonly)



12
13
14
# File 'lib/samsara_api/v_1_messages/client.rb', line 12

def request_client
  @request_client
end

Instance Method Details

#create(driver_ids:, text:, request_options: nil) ⇒ Object

api.v_1_messages.create(driver_ids: [111, 222, 333], text: “This is a message.”)



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/samsara_api/v_1_messages/client.rb', line 100

def create(driver_ids:, text:, 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 || {}), driverIds: driver_ids, text: text }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/fleet/messages"
end
  Samsara::Types::InlineResponse2006.from_json(json_object: response.body)
end

#list(end_ms: nil, duration_ms: nil, request_options: nil) ⇒ Object

api.v_1_messages.list



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/samsara_api/v_1_messages/client.rb', line 54

def list(end_ms: nil, duration_ms: 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 || {}), "endMs": end_ms, "durationMs": duration_ms }.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)}/v1/fleet/messages"
end
  Samsara::Types::InlineResponse2005.from_json(json_object: response.body)
end