Module: Cloudability::Client::Users

Included in:
Cloudability::Client
Defined in:
lib/cloudability/client/users.rb

Instance Method Summary collapse

Instance Method Details

#add_user(email, options = {}) ⇒ Array

Add a user to your organization

Parameters:

  • email (String) —

    of user

  • options (Hash) (defaults to: {}) —

    @option [String] full_name @option [String] role @option [Boolean] restricted @option [Array] new_shared_dimension_filter_set_ids @option [Integer] default_dimension_filter_set_id

Returns:

  • (Array) —

    array of Hashie::Mashes



24
25
26
27
28
29
30
 
# File 'lib/cloudability/client/users.rb', line 24

def add_user(email, options={})
  options[:email] = email

  payload = {user: options}
  request = post '/1/users', payload
  Hashie::Mash.new request
end

#delete_user(id) ⇒ Boolean

Delete a user in your organization

Parameters:

  • ID (Integer) —

    of user

Returns:

  • (Boolean) —

    success



52
53
54
 
# File 'lib/cloudability/client/users.rb', line 52

def delete_user(id)
  delete "/1/users/#{id}"
end

#update_user(id, options = {}) ⇒ Array

Update a user in your organization

Parameters:

  • ID (Integer) —

    of user

  • options (Hash) (defaults to: {}) —

    @option [String] full_name @option [String] role @option [Boolean] restricted @option [Array] new_shared_dimension_filter_set_ids @option [Integer] default_dimension_filter_set_id

Returns:

  • (Array) —

    array of Hashie::Mashes



42
43
44
45
46
 
# File 'lib/cloudability/client/users.rb', line 42

def update_user(id, options={})
  payload = {user: options}
  request = put "/1/users/#{id}", payload
  Hashie::Mash.new request
end

#users ⇒ Array

List users in your organization.

Returns:

  • (Array) —

    array of Hashie::Mashes



9
10
11
12
 
# File 'lib/cloudability/client/users.rb', line 9

def users
  request = get '/1/users'
  convert_to_mashes(request)
end