Class: Samsara::UsersClient

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

Parameters:



24
25
26
 
# File 'lib/samsara_api/users/client.rb', line 24

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

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

)



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/samsara_api/users/client.rb', line 109

def create(auth_type:, email:, expire_at: nil, name:, roles:, 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 || {}), 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

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

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/samsara_api/users/client.rb', line 190

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

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

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/samsara_api/users/client.rb', line 149

def get(id:, 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
  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

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

api.users.list



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

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

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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/samsara_api/users/client.rb', line 243

def update(id:, auth_type: nil, expire_at: nil, name: nil, roles: 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 || {}), 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