class Dogapi::V1::UserService

Defined in:

dogapi/v1/user.cr

Instance Method Summary

Instance methods inherited from class Dogapi::APIService

handle_response(resp) handle_response, prepare_params(extra_params, with_app_key) prepare_params, request(method, url, extra_params, body, send_json, with_app_key = true) request, suppress_error_if_silent(e) suppress_error_if_silent

Constructor methods inherited from class Dogapi::APIService

new(api_key : String, application_key : Nil | String = nil, silent : Bool = true, timeout : Int32 | Nil = nil, endpoint : Nil | String = nil) new

Instance Method Detail

def create_user(description = {} of String => String) #

Create a user

:description => Hash: user description containing 'handle' and 'name' properties


[View source]
def disable_user(handle) #

Disable a user

:handle => String: user handle


[View source]
def get_all_users #

Retrieve all users


[View source]
def get_user(handle) #

Retrieve user information

:handle => String: user handle


[View source]
def invite(emails, options = {} of String => String) #

DEPRECATED: Going forward, we're using a new and more restful API, the new methods are get_user, create_user, update_user, disable_user


[View source]
def update_user(handle, description = {} of String => String) #

Update a user

:handle => String: user handle :description => Hash: user description optionally containing 'name', 'email', 'is_admin', 'disabled' properties


[View source]