module BacklogKit::Client::Group

Methods for the Group API

Public Instance Methods

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

Create a new group

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

# File lib/backlog_kit/client/group.rb, line 26
def create_group(name, params = {})
  params[:name] = name
  post('groups', params)
end
delete_group(group_id) click to toggle source

Delete a group

@param group_id [Integer, String] Group id @return [BacklogKit::Response] The group information

# File lib/backlog_kit/client/group.rb, line 44
def delete_group(group_id)
  delete("groups/#{group_id}")
end
get_group(group_id) click to toggle source

Get a group

@param group_id [Integer, String] Group id @return [BacklogKit::Response] The group information

# File lib/backlog_kit/client/group.rb, line 17
def get_group(group_id)
  get("groups/#{group_id}")
end
get_groups(params = {}) click to toggle source

Get list of groups

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

# File lib/backlog_kit/client/group.rb, line 9
def get_groups(params = {})
  get('groups', params)
end
update_group(group_id, params = {}) click to toggle source

Update a group

@param group_id [Integer, String] Group id @param params [Hash] Request parameters @return [BacklogKit::Response] The group information

# File lib/backlog_kit/client/group.rb, line 36
def update_group(group_id, params = {})
  patch("groups/#{group_id}", params)
end