class Dogapi::V1::UserService
Constants
- API_VERSION
Public Instance Methods
create_user(description= {})
click to toggle source
Create a user
:description => Hash: user description containing 'handle' and 'name' properties
# File lib/dogapi/v1/user.rb 27 def create_user(description= {}) 28 request(Net::HTTP::Post, "/api/#{API_VERSION}/user", nil, description, true) 29 end
disable_user(handle)
click to toggle source
Disable a user
:handle => String: user handle
# File lib/dogapi/v1/user.rb 55 def disable_user(handle) 56 request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", nil, nil, false) 57 end
get_all_users()
click to toggle source
Retrieve all users
# File lib/dogapi/v1/user.rb 39 def get_all_users 40 request(Net::HTTP::Get, "/api/#{API_VERSION}/user", nil, nil, false) 41 end
get_user(handle)
click to toggle source
Retrieve user information
:handle => String: user handle
# File lib/dogapi/v1/user.rb 34 def get_user(handle) 35 request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", nil, nil, false) 36 end
invite(emails, options= {})
click to toggle source
DEPRECATED: Going forward, we're using a new and more restful API, the new methods are get_user
, create_user
, update_user
, disable_user
# File lib/dogapi/v1/user.rb 14 def invite(emails, options= {}) 15 warn '[DEPRECATION] Dogapi::V1::UserService::invite has been deprecated '\ 16 'in favor of Dogapi::V1::UserService::create_user' 17 body = { 18 'emails' => emails, 19 }.merge options 20 21 request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", nil, body, true) 22 end
update_user(handle, description= {})
click to toggle source
Update a user
:handle => String: user handle :description => Hash: user description optionally containing 'name', 'email', 'is_admin', 'disabled' properties
# File lib/dogapi/v1/user.rb 48 def update_user(handle, description= {}) 49 request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", nil, description, true) 50 end