class Confy::Api::Teams
Every organization will have a default team named __Owners__. Owner of the organization will be a default member for every team.
org - Name of the organization
Public Class Methods
# File lib/confy/api/teams.rb, line 10 def initialize(org, client) @org = org @client = client end
Public Instance Methods
Create a team for the given organization. Authenticated user should be the owner of the organization.
'/orgs/:org/teams' POST
name - Name of the team description - Description of the team
# File lib/confy/api/teams.rb, line 30 def create(name, description, options = {}) body = options.fetch(:body, {}) body[:name] = name body[:description] = description @client.post("/orgs/#{@org}/teams", body, options) end
Delete the given team. Cannot delete the default team in the organization. Authenticated user should be the owner of the organization.
'/orgs/:org/teams/:team' DELETE
team - Name of the team
# File lib/confy/api/teams.rb, line 67 def destroy(team, options = {}) body = options.fetch(:body, {}) @client.delete("/orgs/#{@org}/teams/#{team}", body, options) end
List teams of the given organization authenticated user is a member of.
'/orgs/:org/teams' GET
# File lib/confy/api/teams.rb, line 18 def list(options = {}) body = options.fetch(:query, {}) @client.get("/orgs/#{@org}/teams", body, options) end
Retrieve the list of projects the given team has access to. Authenticated user should be a member of the team.
'/orgs/:org/teams/:team/projects' GET
team - Name of the team
# File lib/confy/api/teams.rb, line 78 def projects(team, options = {}) body = options.fetch(:query, {}) @client.get("/orgs/#{@org}/teams/#{team}/projects", body, options) end
Get the given team in the given organization. Access
only if the authenticated user is a member of the team.
'/orgs/:org/teams/:team' GET
team - Name of the team
# File lib/confy/api/teams.rb, line 43 def retrieve(team, options = {}) body = options.fetch(:query, {}) @client.get("/orgs/#{@org}/teams/#{team}", body, options) end
Update the given team. __Description__ is the only thing which can be updated. Authenticated user should be the owner of the organization.
'/orgs/:org/teams/:team' PATCH
team - Name of the team description - Description of the team
# File lib/confy/api/teams.rb, line 55 def update(team, description, options = {}) body = options.fetch(:body, {}) body[:description] = description @client.patch("/orgs/#{@org}/teams/#{team}", body, options) end