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, line 33 def create_user(description = {}) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Post, "/api/#{API_VERSION}/user", params, description, true) rescue Exception => e suppress_error_if_silent e end end
disable_user(handle)
click to toggle source
Disable a user
:handle => String: user handle
# File lib/dogapi/v1/user.rb, line 97 def disable_user(handle) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", params, nil, false) rescue Exception => e suppress_error_if_silent e end end
get_all_users()
click to toggle source
Retrieve all users
# File lib/dogapi/v1/user.rb, line 63 def get_all_users() begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Get, "/api/#{API_VERSION}/user", params, nil, false) rescue Exception => e suppress_error_if_silent e end end
get_user(handle)
click to toggle source
Retrieve user information
:handle => String: user handle
# File lib/dogapi/v1/user.rb, line 49 def get_user(handle) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", params, nil, false) rescue Exception => e suppress_error_if_silent e end 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, line 12 def invite(emails, options = {}) warn "[DEPRECATION] Dogapi::V1::UserService::invite has been deprecated in favor of Dogapi::V1::UserService::create_user" begin params = { :api_key => @api_key, :application_key => @application_key } body = { 'emails' => emails, }.merge options request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", params, body, true) rescue Exception => e suppress_error_if_silent e end 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, line 81 def update_user(handle, description = {}) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", params, description, true) rescue Exception => e suppress_error_if_silent e end end