Module: Gitlab::Client::Groups
- Included in:
- Gitlab::Client
- Defined in:
- lib/gitlab/client/groups.rb
Overview
Defines methods related to groups.
Instance Method Summary collapse
-
#add_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to group.
-
#create_group(name, path, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new group.
-
#delete_group(id) ⇒ Gitlab::ObjectifiedHash
Delete’s a group.
-
#edit_group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing group.
-
#edit_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Edit a user of a group.
-
#group(id) ⇒ Gitlab::ObjectifiedHash
Gets a single group.
-
#group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Get details of a single group member.
-
#group_members(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of group members.
-
#group_projects(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of projects under a group.
-
#group_search(search, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for groups by name.
-
#group_subgroups(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of subgroups under a group.
-
#groups(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of groups.
-
#remove_group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Removes user from user group.
-
#transfer_project_to_group(id, project_id) ⇒ Object
Transfers a project to a group.
Instance Method Details
#add_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to group.
90 91 92 |
# File 'lib/gitlab/client/groups.rb', line 90 def add_group_member(team_id, user_id, access_level) post("/groups/#{url_encode team_id}/members", body: { user_id: user_id, access_level: access_level }) end |
#create_group(name, path, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new group.
39 40 41 42 |
# File 'lib/gitlab/client/groups.rb', line 39 def create_group(name, path, ={}) body = { name: name, path: path }.merge() post("/groups", body: body) end |
#delete_group(id) ⇒ Gitlab::ObjectifiedHash
Delete’s a group.
50 51 52 |
# File 'lib/gitlab/client/groups.rb', line 50 def delete_group(id) delete("/groups/#{url_encode id}") end |
#edit_group(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing group.
189 190 191 |
# File 'lib/gitlab/client/groups.rb', line 189 def edit_group(id, ={}) put("/groups/#{url_encode id}", body: ) end |
#edit_group_member(team_id, user_id, access_level) ⇒ Gitlab::ObjectifiedHash
Edit a user of a group.
103 104 105 |
# File 'lib/gitlab/client/groups.rb', line 103 def edit_group_member(team_id, user_id, access_level) put("/groups/#{url_encode team_id}/members/#{user_id}", body: { access_level: access_level }) end |
#group(id) ⇒ Gitlab::ObjectifiedHash
Gets a single group.
26 27 28 |
# File 'lib/gitlab/client/groups.rb', line 26 def group(id) get("/groups/#{url_encode id}") end |
#group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Get details of a single group member.
77 78 79 |
# File 'lib/gitlab/client/groups.rb', line 77 def group_member(team_id, user_id) get("/groups/#{url_encode team_id}/members/#{user_id}") end |
#group_members(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of group members.
65 66 67 |
# File 'lib/gitlab/client/groups.rb', line 65 def group_members(id, ={}) get("/groups/#{url_encode id}/members", query: ) end |
#group_projects(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of projects under a group
152 153 154 |
# File 'lib/gitlab/client/groups.rb', line 152 def group_projects(id, ={}) get("/groups/#{url_encode id}/projects", query: ) end |
#group_search(search, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for groups by name
141 142 143 144 |
# File 'lib/gitlab/client/groups.rb', line 141 def group_search(search, ={}) [:search] = search get("/groups", query: ) end |
#group_subgroups(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of subgroups under a group
170 171 172 |
# File 'lib/gitlab/client/groups.rb', line 170 def group_subgroups(id, ={}) get("/groups/#{url_encode id}/subgroups", query: ) end |
#groups(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of groups.
15 16 17 |
# File 'lib/gitlab/client/groups.rb', line 15 def groups(={}) get("/groups", query: ) end |
#remove_group_member(team_id, user_id) ⇒ Gitlab::ObjectifiedHash
Removes user from user group.
115 116 117 |
# File 'lib/gitlab/client/groups.rb', line 115 def remove_group_member(team_id, user_id) delete("/groups/#{url_encode team_id}/members/#{user_id}") end |
#transfer_project_to_group(id, project_id) ⇒ Object
Transfers a project to a group
126 127 128 129 |
# File 'lib/gitlab/client/groups.rb', line 126 def transfer_project_to_group(id, project_id) body = { id: id, project_id: project_id } post("/groups/#{url_encode id}/projects/#{project_id}", body: body) end |