Class: Samsara::Vehicles::LocationsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::Vehicles::LocationsClient

Parameters:



19
20
21
 
# File 'lib/samsara_api/vehicles/locations/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



14
15
16
 
# File 'lib/samsara_api/vehicles/locations/client.rb', line 14

def request_client
  @request_client
end

Instance Method Details

#feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, request_options: nil) ⇒ Object

api.vehicles.locations.feed



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/samsara_api/vehicles/locations/client.rb', line 123

def feed(after: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_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 || {}), "after": after, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_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)}/fleet/vehicles/locations/feed"
end
  Samsara::Types::VehicleLocationsListResponse.from_json(json_object: response.body)
end

#history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, request_options: nil) ⇒ Object

api.vehicles.locations.history(start_time: "startTime", end_time: "endTime")



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/samsara_api/vehicles/locations/client.rb', line 183

def history(after: nil, start_time:, end_time:, parent_tag_ids: nil, tag_ids: nil, vehicle_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 || {}), "after": after, "startTime": start_time, "endTime": end_time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_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)}/fleet/vehicles/locations/history"
end
  Samsara::Types::VehicleLocationsListResponse.from_json(json_object: response.body)
end

#list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_ids: nil, request_options: nil) ⇒ Object

api.vehicles.locations.list



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/samsara_api/vehicles/locations/client.rb', line 64

def list(after: nil, time: nil, parent_tag_ids: nil, tag_ids: nil, vehicle_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 || {}), "after": after, "time": time, "parentTagIds": parent_tag_ids, "tagIds": tag_ids, "vehicleIds": vehicle_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)}/fleet/vehicles/locations"
end
  Samsara::Types::VehicleLocationsResponse.from_json(json_object: response.body)
end