Class: Datacentred::Request::Users
- Defined in:
- lib/datacentred/request/users.rb
Overview
RESTful API requests for the user endpoints.
Class Method Summary collapse
-
.create(params) ⇒ Object
Create a new user.
-
.destroy(id) ⇒ nil
Permanently remove the specified user.
-
.list ⇒ [Hash]
List all available users.
-
.show(id) ⇒ Hash
Find a user by unique ID.
-
.update(id, params) ⇒ Hash
Update a user by unique ID.
Methods inherited from Base
Class Method Details
.create(params) ⇒ Object
Create a new user.
POST /api/users
@return [Hash] New user.
14 15 16 |
# File 'lib/datacentred/request/users.rb', line 14 def create(params) post('users', 'user' => params)['user'] end |
.destroy(id) ⇒ nil
Permanently remove the specified user.
DELETE /api/users/82fa8de8f09102cc
63 64 65 |
# File 'lib/datacentred/request/users.rb', line 63 def destroy(id) delete("users/#{id}") end |
.list ⇒ [Hash]
List all available users.
GET /api/users
24 25 26 |
# File 'lib/datacentred/request/users.rb', line 24 def list get('users')['users'] end |
.show(id) ⇒ Hash
Find a user by unique ID.
GET /api/users/82fa8de8f09102cc
36 37 38 |
# File 'lib/datacentred/request/users.rb', line 36 def show(id) get("users/#{id}")['user'] end |
.update(id, params) ⇒ Hash
Update a user by unique ID.
PUT /api/users/82fa8de8f09102cc
50 51 52 |
# File 'lib/datacentred/request/users.rb', line 50 def update(id, params) put("users/#{id}", 'user' => params)['user'] end |