Class: Datacentred::Request::Users

Inherits:
Base
  • Object
show all
Defined in:
lib/datacentred/request/users.rb

Overview

RESTful API requests for the user endpoints.

Class Method Summary collapse

Methods inherited from Base

delete, get, post, put

Class Method Details

.create(params) ⇒ Object

Create a new user.

POST /api/users

 @return [Hash] New user.

Parameters:

  • params (Hash)

    User attributes.

Raises:



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

Parameters:

  • id (String)

    The unique identifier for this user.

Returns:

  • (nil)

    Confirms the user was destroyed.

Raises:



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

Returns:

  • ([Hash])

    A collection of all users on this account.

Raises:



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

Parameters:

  • id (String)

    The unique identifier for this user.

Returns:

  • (Hash)

    The user, if it exists.

Raises:



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

Parameters:

  • id (String)

    The unique identifier for this user.

  • params (Hash)

    User attributes.

Returns:

  • (Hash)

    The updated user.

Raises:



50
51
52
# File 'lib/datacentred/request/users.rb', line 50

def update(id, params)
  put("users/#{id}", 'user' => params)['user']
end