Class: Samsara::AsyncClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: nil, environment: Samsara::Environment::PRODUCTION_API, max_retries: nil, timeout_in_seconds: nil, token: ENV["SAMSARA_API_KEY"]) ⇒ Samsara::AsyncClient

Parameters:

  • base_url (String) (defaults to: nil)
  • environment (Samsara::Environment) (defaults to: Samsara::Environment::PRODUCTION_API)
  • max_retries (Long) (defaults to: nil) —

    The number of times to retry a failed request, defaults to 2.

  • timeout_in_seconds (Long) (defaults to: nil)
  • token (String) (defaults to: ENV["SAMSARA_API_KEY"]) 


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/samsara_api.rb', line 339

def initialize(base_url: nil, environment: Samsara::Environment::PRODUCTION_API, max_retries: nil, timeout_in_seconds: nil, token: ENV["SAMSARA_API_KEY"])
  @async_request_client = Samsara::AsyncRequestClient.new(
  base_url: base_url,
  environment: environment,
  max_retries: max_retries,
  timeout_in_seconds: timeout_in_seconds,
  token: token
)
  @addresses = Samsara::AsyncAddressesClient.new(request_client: @async_request_client)
  @assets = Samsara::AsyncAssetsClient.new(request_client: @async_request_client)
  @inputs = Samsara::AsyncInputsClient.new(request_client: @async_request_client)
  @attributes = Samsara::AsyncAttributesClient.new(request_client: @async_request_client)
  @contacts = Samsara::AsyncContactsClient.new(request_client: @async_request_client)
  @defect_types = Samsara::AsyncDefectTypesClient.new(request_client: @async_request_client)
  @defects = Samsara::AsyncDefectsClient.new(request_client: @async_request_client)
  @devices = Samsara::AsyncDevicesClient.new(request_client: @async_request_client)
  @driver_trailer_assignments = Samsara::AsyncDriverTrailerAssignmentsClient.new(request_client: @async_request_client)
  @dvirs = Samsara::AsyncDvirsClient.new(request_client: @async_request_client)
  @carrier_proposed_assignments = Samsara::AsyncCarrierProposedAssignmentsClient.new(request_client: @async_request_client)
  @document_types = Samsara::AsyncDocumentTypesClient.new(request_client: @async_request_client)
  @documents = Samsara::AsyncDocumentsClient.new(request_client: @async_request_client)
  @driver_vehicle_assignments = Samsara::AsyncDriverVehicleAssignmentsClient.new(request_client: @async_request_client)
  @drivers = Samsara::AsyncDriversClient.new(request_client: @async_request_client)
  @equipment = Samsara::AsyncEquipmentClient.new(request_client: @async_request_client)
  @hos = Samsara::AsyncHosClient.new(request_client: @async_request_client)
  @routes = Samsara::AsyncRoutesClient.new(request_client: @async_request_client)
  @safety_events = Samsara::AsyncSafetyEventsClient.new(request_client: @async_request_client)
  @trailers = Samsara::AsyncTrailersClient.new(request_client: @async_request_client)
  @vehicles = Samsara::AsyncVehiclesClient.new(request_client: @async_request_client)
  @legacy = Samsara::AsyncLegacyClient.new(request_client: @async_request_client)
  @form_submissions = Samsara::AsyncFormSubmissionsClient.new(request_client: @async_request_client)
  @forms = Samsara::AsyncFormsClient.new(request_client: @async_request_client)
  @fuel_purchases = Samsara::AsyncFuelPurchasesClient.new(request_client: @async_request_client)
  @gateways = Samsara::AsyncGatewaysClient.new(request_client: @async_request_client)
  @idling = Samsara::AsyncIdlingClient.new(request_client: @async_request_client)
  @issues = Samsara::AsyncIssuesClient.new(request_client: @async_request_client)
  @live_shares = Samsara::AsyncLiveSharesClient.new(request_client: @async_request_client)
  @me = Samsara::AsyncMeClient.new(request_client: @async_request_client)
  @readings = Samsara::AsyncReadingsClient.new(request_client: @async_request_client)
  @speeding_intervals = Samsara::AsyncSpeedingIntervalsClient.new(request_client: @async_request_client)
  @tags = Samsara::AsyncTagsClient.new(request_client: @async_request_client)
  @training_assignments = Samsara::AsyncTrainingAssignmentsClient.new(request_client: @async_request_client)
  @training_courses = Samsara::AsyncTrainingCoursesClient.new(request_client: @async_request_client)
  @trips = Samsara::AsyncTripsClient.new(request_client: @async_request_client)
  @user_roles = Samsara::AsyncUserRolesClient.new(request_client: @async_request_client)
  @users = Samsara::AsyncUsersClient.new(request_client: @async_request_client)
  @v_1_messages = Samsara::AsyncV1MessagesClient.new(request_client: @async_request_client)
  @webhooks = Samsara::AsyncWebhooksClient.new(request_client: @async_request_client)
  @alerts = Samsara::Alerts::AsyncClient.new(request_client: @async_request_client)
  @auth = Samsara::Auth::AsyncClient.new(request_client: @async_request_client)
  @cameras = Samsara::Cameras::AsyncClient.new(request_client: @async_request_client)
  @coaching = Samsara::Coaching::AsyncClient.new(request_client: @async_request_client)
  @ifta = Samsara::Ifta::AsyncClient.new(request_client: @async_request_client)
  @maintenance = Samsara::Maintenance::AsyncClient.new(request_client: @async_request_client)
  @reports = Samsara::Reports::AsyncClient.new(request_client: @async_request_client)
  @settings = Samsara::Settings::AsyncClient.new(request_client: @async_request_client)
  @tachograph = Samsara::Tachograph::AsyncClient.new(request_client: @async_request_client)
end

Instance Attribute Details

#addresses ⇒ Samsara::AsyncAddressesClient (readonly)

Returns:



234
235
236
 
# File 'lib/samsara_api.rb', line 234

def addresses
  @addresses
end

#alerts ⇒ Samsara::Alerts::AsyncClient (readonly)

Returns:



314
315
316
 
# File 'lib/samsara_api.rb', line 314

def alerts
  @alerts
end

#assets ⇒ Samsara::AsyncAssetsClient (readonly)

Returns:



236
237
238
 
# File 'lib/samsara_api.rb', line 236

def assets
  @assets
end

#attributes ⇒ Samsara::AsyncAttributesClient (readonly)

Returns:



240
241
242
 
# File 'lib/samsara_api.rb', line 240

def attributes
  @attributes
end

#auth ⇒ Samsara::Auth::AsyncClient (readonly)

Returns:



316
317
318
 
# File 'lib/samsara_api.rb', line 316

def auth
  @auth
end

#cameras ⇒ Samsara::Cameras::AsyncClient (readonly)

Returns:



318
319
320
 
# File 'lib/samsara_api.rb', line 318

def cameras
  @cameras
end

#carrier_proposed_assignments ⇒ Samsara::AsyncCarrierProposedAssignmentsClient (readonly)

Returns:



254
255
256
 
# File 'lib/samsara_api.rb', line 254

def carrier_proposed_assignments
  @carrier_proposed_assignments
end

#coaching ⇒ Samsara::Coaching::AsyncClient (readonly)

Returns:



320
321
322
 
# File 'lib/samsara_api.rb', line 320

def coaching
  @coaching
end

#contacts ⇒ Samsara::AsyncContactsClient (readonly)

Returns:



242
243
244
 
# File 'lib/samsara_api.rb', line 242

def contacts
  @contacts
end

#defect_types ⇒ Samsara::AsyncDefectTypesClient (readonly)

Returns:



244
245
246
 
# File 'lib/samsara_api.rb', line 244

def defect_types
  @defect_types
end

#defects ⇒ Samsara::AsyncDefectsClient (readonly)

Returns:



246
247
248
 
# File 'lib/samsara_api.rb', line 246

def defects
  @defects
end

#devices ⇒ Samsara::AsyncDevicesClient (readonly)

Returns:



248
249
250
 
# File 'lib/samsara_api.rb', line 248

def devices
  @devices
end

#document_types ⇒ Samsara::AsyncDocumentTypesClient (readonly)

Returns:



256
257
258
 
# File 'lib/samsara_api.rb', line 256

def document_types
  @document_types
end

#documents ⇒ Samsara::AsyncDocumentsClient (readonly)

Returns:



258
259
260
 
# File 'lib/samsara_api.rb', line 258

def documents
  @documents
end

#driver_trailer_assignments ⇒ Samsara::AsyncDriverTrailerAssignmentsClient (readonly)

Returns:



250
251
252
 
# File 'lib/samsara_api.rb', line 250

def driver_trailer_assignments
  @driver_trailer_assignments
end

#driver_vehicle_assignments ⇒ Samsara::AsyncDriverVehicleAssignmentsClient (readonly)

Returns:



260
261
262
 
# File 'lib/samsara_api.rb', line 260

def driver_vehicle_assignments
  @driver_vehicle_assignments
end

#drivers ⇒ Samsara::AsyncDriversClient (readonly)

Returns:



262
263
264
 
# File 'lib/samsara_api.rb', line 262

def drivers
  @drivers
end

#dvirs ⇒ Samsara::AsyncDvirsClient (readonly)

Returns:



252
253
254
 
# File 'lib/samsara_api.rb', line 252

def dvirs
  @dvirs
end

#equipment ⇒ Samsara::AsyncEquipmentClient (readonly)

Returns:



264
265
266
 
# File 'lib/samsara_api.rb', line 264

def equipment
  @equipment
end

#form_submissions ⇒ Samsara::AsyncFormSubmissionsClient (readonly)

Returns:



278
279
280
 
# File 'lib/samsara_api.rb', line 278

def form_submissions
  @form_submissions
end

#forms ⇒ Samsara::AsyncFormsClient (readonly)

Returns:



280
281
282
 
# File 'lib/samsara_api.rb', line 280

def forms
  @forms
end

#fuel_purchases ⇒ Samsara::AsyncFuelPurchasesClient (readonly)

Returns:



282
283
284
 
# File 'lib/samsara_api.rb', line 282

def fuel_purchases
  @fuel_purchases
end

#gateways ⇒ Samsara::AsyncGatewaysClient (readonly)

Returns:



284
285
286
 
# File 'lib/samsara_api.rb', line 284

def gateways
  @gateways
end

#hos ⇒ Samsara::AsyncHosClient (readonly)

Returns:



266
267
268
 
# File 'lib/samsara_api.rb', line 266

def hos
  @hos
end

#idling ⇒ Samsara::AsyncIdlingClient (readonly)

Returns:



286
287
288
 
# File 'lib/samsara_api.rb', line 286

def idling
  @idling
end

#ifta ⇒ Samsara::Ifta::AsyncClient (readonly)

Returns:



322
323
324
 
# File 'lib/samsara_api.rb', line 322

def ifta
  @ifta
end

#inputs ⇒ Samsara::AsyncInputsClient (readonly)

Returns:



238
239
240
 
# File 'lib/samsara_api.rb', line 238

def inputs
  @inputs
end

#issues ⇒ Samsara::AsyncIssuesClient (readonly)

Returns:



288
289
290
 
# File 'lib/samsara_api.rb', line 288

def issues
  @issues
end

#legacy ⇒ Samsara::AsyncLegacyClient (readonly)

Returns:



276
277
278
 
# File 'lib/samsara_api.rb', line 276

def legacy
  @legacy
end

#live_shares ⇒ Samsara::AsyncLiveSharesClient (readonly)

Returns:



290
291
292
 
# File 'lib/samsara_api.rb', line 290

def live_shares
  @live_shares
end

#maintenance ⇒ Samsara::Maintenance::AsyncClient (readonly)

Returns:



324
325
326
 
# File 'lib/samsara_api.rb', line 324

def maintenance
  @maintenance
end

#me ⇒ Samsara::AsyncMeClient (readonly)

Returns:



292
293
294
 
# File 'lib/samsara_api.rb', line 292

def me
  @me
end

#readings ⇒ Samsara::AsyncReadingsClient (readonly)

Returns:



294
295
296
 
# File 'lib/samsara_api.rb', line 294

def readings
  @readings
end

#reports ⇒ Samsara::Reports::AsyncClient (readonly)

Returns:



326
327
328
 
# File 'lib/samsara_api.rb', line 326

def reports
  @reports
end

#routes ⇒ Samsara::AsyncRoutesClient (readonly)

Returns:



268
269
270
 
# File 'lib/samsara_api.rb', line 268

def routes
  @routes
end

#safety_events ⇒ Samsara::AsyncSafetyEventsClient (readonly)

Returns:



270
271
272
 
# File 'lib/samsara_api.rb', line 270

def safety_events
  @safety_events
end

#settings ⇒ Samsara::Settings::AsyncClient (readonly)

Returns:



328
329
330
 
# File 'lib/samsara_api.rb', line 328

def settings
  @settings
end

#speeding_intervals ⇒ Samsara::AsyncSpeedingIntervalsClient (readonly)

Returns:



296
297
298
 
# File 'lib/samsara_api.rb', line 296

def speeding_intervals
  @speeding_intervals
end

#tachograph ⇒ Samsara::Tachograph::AsyncClient (readonly)

Returns:



330
331
332
 
# File 'lib/samsara_api.rb', line 330

def tachograph
  @tachograph
end

#tags ⇒ Samsara::AsyncTagsClient (readonly)

Returns:



298
299
300
 
# File 'lib/samsara_api.rb', line 298

def tags
  @tags
end

#trailers ⇒ Samsara::AsyncTrailersClient (readonly)

Returns:



272
273
274
 
# File 'lib/samsara_api.rb', line 272

def trailers
  @trailers
end

#training_assignments ⇒ Samsara::AsyncTrainingAssignmentsClient (readonly)

Returns:



300
301
302
 
# File 'lib/samsara_api.rb', line 300

def training_assignments
  @training_assignments
end

#training_courses ⇒ Samsara::AsyncTrainingCoursesClient (readonly)

Returns:



302
303
304
 
# File 'lib/samsara_api.rb', line 302

def training_courses
  @training_courses
end

#trips ⇒ Samsara::AsyncTripsClient (readonly)

Returns:



304
305
306
 
# File 'lib/samsara_api.rb', line 304

def trips
  @trips
end

#user_roles ⇒ Samsara::AsyncUserRolesClient (readonly)

Returns:



306
307
308
 
# File 'lib/samsara_api.rb', line 306

def user_roles
  @user_roles
end

#users ⇒ Samsara::AsyncUsersClient (readonly)

Returns:



308
309
310
 
# File 'lib/samsara_api.rb', line 308

def users
  @users
end

#v_1_messages ⇒ Samsara::AsyncV1MessagesClient (readonly)

Returns:



310
311
312
 
# File 'lib/samsara_api.rb', line 310

def v_1_messages
  @v_1_messages
end

#vehicles ⇒ Samsara::AsyncVehiclesClient (readonly)

Returns:



274
275
276
 
# File 'lib/samsara_api.rb', line 274

def vehicles
  @vehicles
end

#webhooks ⇒ Samsara::AsyncWebhooksClient (readonly)

Returns:



312
313
314
 
# File 'lib/samsara_api.rb', line 312

def webhooks
  @webhooks
end