Class: Samsara::AsyncUsersClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::AsyncUsersClient

Parameters:



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

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::AsyncRequestClient (readonly)

Returns:



263
264
265
 
# File 'lib/samsara_api/users/client.rb', line 263

def request_client
  @request_client
end

Instance Method Details

#create(auth_type:, email:, expire_at: nil, name:, roles:, request_options: nil) ⇒ Object

)



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/samsara_api/users/client.rb', line 355

def create(auth_type:, email:, expire_at: nil, name:, roles:, 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 || {}), authType: auth_type, email: email, expireAt: expire_at, name: name, roles: roles }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/users"
end
    Samsara::Types::UserResponse.from_json(json_object: response.body)
  end
end

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

api.users.delete(id: “id”)



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/samsara_api/users/client.rb', line 440

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
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  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)}/users/#{id}"
end
    parsed_json = JSON.parse(response.body)
    parsed_json
  end
end

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

api.users.get(id: “id”)



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/samsara_api/users/client.rb', line 397

def get(id:, 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
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  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)}/users/#{id}"
end
    Samsara::Types::UserResponse.from_json(json_object: response.body)
  end
end

#list(limit: nil, after: nil, request_options: nil) ⇒ Object

api.users.list



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/samsara_api/users/client.rb', line 298

def list(limit: nil, after: 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 || {}), "limit": limit, "after": after }.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)}/users"
end
    Samsara::Types::ListUsersResponse.from_json(json_object: response.body)
  end
end

#update(id:, auth_type: nil, expire_at: nil, name: nil, roles: nil, request_options: nil) ⇒ Object

api.users.update(id: “id”)



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/samsara_api/users/client.rb', line 495

def update(id:, auth_type: nil, expire_at: nil, name: nil, roles: 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 || {}), authType: auth_type, expireAt: expire_at, name: name, roles: roles }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/users/#{id}"
end
    Samsara::Types::UserResponse.from_json(json_object: response.body)
  end
end