module BacklogKit::Client::Team

Methods for the Team API

Public Instance Methods

create_team(name, params = {}) click to toggle source

Create a new team

@param name [String] Team name @param params [Hash] Request parameters @return [BacklogKit::Response] The team information

# File lib/backlog_kit/client/team.rb, line 26
def create_team(name, params = {})
  params[:name] = name
  post('teams', params)
end
delete_team(team_id) click to toggle source

Delete a team

@param team_id [Integer, String] Team id @return [BacklogKit::Response] The team information

# File lib/backlog_kit/client/team.rb, line 44
def delete_team(team_id)
  delete("teams/#{team_id}")
end
download_team_icon(team_id) click to toggle source

Download a team icon image

@param team_id [Integer, String] Team id @return [BacklogKit::Response] Binary image data

# File lib/backlog_kit/client/team.rb, line 52
def download_team_icon(team_id)
  get("teams/#{team_id}/icon")
end
get_team(team_id) click to toggle source

Get a team

@param team_id [Integer, String] Team id @return [BacklogKit::Response] The team information

# File lib/backlog_kit/client/team.rb, line 17
def get_team(team_id)
  get("teams/#{team_id}")
end
get_teams(params = {}) click to toggle source

Get list of teams

@param params [Hash] Request parameters @return [BacklogKit::Response] List of teams

# File lib/backlog_kit/client/team.rb, line 9
def get_teams(params = {})
  get('teams', params)
end
update_team(team_id, params = {}) click to toggle source

Update a team

@param team_id [Integer, String] Team id @param params [Hash] Request parameters @return [BacklogKit::Response] The team information

# File lib/backlog_kit/client/team.rb, line 36
def update_team(team_id, params = {})
  patch("teams/#{team_id}", params)
end