Module: BacklogKit::Client::User

Included in:
BacklogKit::Client
Defined in:
lib/backlog_kit/client/user.rb

Overview

Methods for the User API

Instance Method Summary collapse

Instance Method Details

#create_user(params = {}) ⇒ BacklogKit::Response

Create a new user

Parameters:

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

    Request parameters

Returns:



26
27
28
 
# File 'lib/backlog_kit/client/user.rb', line 26

def create_user(params = {})
  post('users', params)
end

#delete_user(user_id) ⇒ BacklogKit::Response

Delete a user

Parameters:

  • user_id (Integer, String) —

    User id

Returns:



43
44
45
 
# File 'lib/backlog_kit/client/user.rb', line 43

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

#download_user_icon(user_id) ⇒ BacklogKit::Response

Download a user icon image

Parameters:

  • user_id (Integer, String) —

    User id

Returns:



58
59
60
 
# File 'lib/backlog_kit/client/user.rb', line 58

def download_user_icon(user_id)
  get("users/#{user_id}/icon")
end

#get_myself ⇒ BacklogKit::Response

Get a authentication user

Returns:



50
51
52
 
# File 'lib/backlog_kit/client/user.rb', line 50

def get_myself
  get('users/myself')
end

#get_recently_viewed_issues(params = {}) ⇒ BacklogKit::Response

Get list of recently viewed issues

Parameters:

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

    Request parameters

Returns:



93
94
95
 
# File 'lib/backlog_kit/client/user.rb', line 93

def get_recently_viewed_issues(params = {})
  get('users/myself/recentlyViewedIssues', params)
end

#get_recently_viewed_projects(params = {}) ⇒ BacklogKit::Response

Get list of recently viewed projects

Parameters:

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

    Request parameters

Returns:



101
102
103
 
# File 'lib/backlog_kit/client/user.rb', line 101

def get_recently_viewed_projects(params = {})
  get('users/myself/recentlyViewedProjects', params)
end

#get_recently_viewed_wikis(params = {}) ⇒ BacklogKit::Response

Get list of recently viewed wiki pages

Parameters:

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

    Request parameters

Returns:



109
110
111
 
# File 'lib/backlog_kit/client/user.rb', line 109

def get_recently_viewed_wikis(params = {})
  get('users/myself/recentlyViewedWikis', params)
end

#get_user(user_id) ⇒ BacklogKit::Response

Get a user

Parameters:

  • user_id (Integer, String) —

    User id

Returns:



18
19
20
 
# File 'lib/backlog_kit/client/user.rb', line 18

def get_user(user_id)
  get("users/#{user_id}")
end

#get_user_activities(user_id, params = {}) ⇒ BacklogKit::Response

Get list of user activities

Parameters:

  • user_id (Integer, String) —

    User id

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

    Request parameters

Returns:



67
68
69
 
# File 'lib/backlog_kit/client/user.rb', line 67

def get_user_activities(user_id, params = {})
  get("users/#{user_id}/activities", params)
end

#get_user_star_count(user_id, params = {}) ⇒ BacklogKit::Response

Get number of user stars

Parameters:

  • user_id (Integer, String) —

    User id

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

    Request parameters

Returns:



85
86
87
 
# File 'lib/backlog_kit/client/user.rb', line 85

def get_user_star_count(user_id, params = {})
  get("users/#{user_id}/stars/count", params)
end

#get_user_stars(user_id, params = {}) ⇒ BacklogKit::Response

Get list of user stars

Parameters:

  • user_id (Integer, String) —

    User id

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

    Request parameters

Returns:



76
77
78
 
# File 'lib/backlog_kit/client/user.rb', line 76

def get_user_stars(user_id, params = {})
  get("users/#{user_id}/stars", params)
end

#get_users ⇒ BacklogKit::Response

Get list of users

Returns:



10
11
12
 
# File 'lib/backlog_kit/client/user.rb', line 10

def get_users
  get('users')
end

#update_user(user_id, params = {}) ⇒ BacklogKit::Response

Update a user

Parameters:

  • user_id (Integer, String) —

    User id

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

    Request parameters

Returns:



35
36
37
 
# File 'lib/backlog_kit/client/user.rb', line 35

def update_user(user_id, params = {})
  patch("users/#{user_id}", params)
end