module BacklogKit::Client::User

Methods for the User API

Public Instance Methods

create_user(params = {}) click to toggle source

Create a new user

@param params [Hash] Request parameters @return [BacklogKit::Response] The user information

# File lib/backlog_kit/client/user.rb, line 24
def create_user(params = {})
  post('users', params)
end
delete_user(user_id) click to toggle source

Delete a user

@param user_id [Integer, String] User id @return [BacklogKit::Response] The user information

# File lib/backlog_kit/client/user.rb, line 41
def delete_user(user_id)
  delete("users/#{user_id}")
end
download_user_icon(user_id) click to toggle source

Download a user icon image

@param user_id [Integer, String] User id @return [BacklogKit::Response] Binary image data

# File lib/backlog_kit/client/user.rb, line 56
def download_user_icon(user_id)
  get("users/#{user_id}/icon")
end
get_myself() click to toggle source

Get a authentication user

@return [BacklogKit::Response] The user information

# File lib/backlog_kit/client/user.rb, line 48
def get_myself
  get('users/myself')
end
get_recently_viewed_issues(params = {}) click to toggle source

Get list of recently viewed issues

@param params [Hash] Request parameters @return [BacklogKit::Response] List of recently viewed issues

# File lib/backlog_kit/client/user.rb, line 91
def get_recently_viewed_issues(params = {})
  get('users/myself/recentlyViewedIssues', params)
end
get_recently_viewed_projects(params = {}) click to toggle source

Get list of recently viewed projects

@param params [Hash] Request parameters @return [BacklogKit::Response] List of recently viewed projects

# File lib/backlog_kit/client/user.rb, line 99
def get_recently_viewed_projects(params = {})
  get('users/myself/recentlyViewedProjects', params)
end
get_recently_viewed_wikis(params = {}) click to toggle source

Get list of recently viewed wiki pages

@param params [Hash] Request parameters @return [BacklogKit::Response] List of recently viewed pages

# File lib/backlog_kit/client/user.rb, line 107
def get_recently_viewed_wikis(params = {})
  get('users/myself/recentlyViewedWikis', params)
end
get_user(user_id) click to toggle source

Get a user

@param user_id [Integer, String] User id @return [BacklogKit::Response] The user information

# File lib/backlog_kit/client/user.rb, line 16
def get_user(user_id)
  get("users/#{user_id}")
end
get_user_activities(user_id, params = {}) click to toggle source

Get list of user activities

@param user_id [Integer, String] User id @param params [Hash] Request parameters @return [BacklogKit::Response] List of user's recent updates

# File lib/backlog_kit/client/user.rb, line 65
def get_user_activities(user_id, params = {})
  get("users/#{user_id}/activities", params)
end
get_user_star_count(user_id, params = {}) click to toggle source

Get number of user stars

@param user_id [Integer, String] User id @param params [Hash] Request parameters @return [BacklogKit::Response] Number of stars

# File lib/backlog_kit/client/user.rb, line 83
def get_user_star_count(user_id, params = {})
  get("users/#{user_id}/stars/count", params)
end
get_user_stars(user_id, params = {}) click to toggle source

Get list of user stars

@param user_id [Integer, String] User id @param params [Hash] Request parameters @return [BacklogKit::Response] List of stars

# File lib/backlog_kit/client/user.rb, line 74
def get_user_stars(user_id, params = {})
  get("users/#{user_id}/stars", params)
end
get_users() click to toggle source

Get list of users

@return [BacklogKit::Response] List of users

# File lib/backlog_kit/client/user.rb, line 8
def get_users
  get('users')
end
update_user(user_id, params = {}) click to toggle source

Update a user

@param user_id [Integer, String] User id @param params [Hash] Request parameters @return [BacklogKit::Response] The user information

# File lib/backlog_kit/client/user.rb, line 33
def update_user(user_id, params = {})
  patch("users/#{user_id}", params)
end