Module: BacklogKit::Client::Group

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

Overview

Methods for the Group API

Instance Method Summary collapse

Instance Method Details

#create_group(name, params = {}) ⇒ BacklogKit::Response

Create a new group

Parameters:

  • name (String) —

    Group name

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

    Request parameters

Returns:



28
29
30
31
 
# File 'lib/backlog_kit/client/group.rb', line 28

def create_group(name, params = {})
  params.merge!(name: name)
  post('groups', params)
end

#delete_group(group_id) ⇒ BacklogKit::Response

Delete a group

Parameters:

  • group_id (Integer, String) —

    Group id

Returns:



46
47
48
 
# File 'lib/backlog_kit/client/group.rb', line 46

def delete_group(group_id)
  delete("groups/#{group_id}")
end

#get_group(group_id) ⇒ BacklogKit::Response

Get a group

Parameters:

  • group_id (Integer, String) —

    Group id

Returns:



19
20
21
 
# File 'lib/backlog_kit/client/group.rb', line 19

def get_group(group_id)
  get("groups/#{group_id}")
end

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

Get list of groups

Parameters:

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

    Request parameters

Returns:



11
12
13
 
# File 'lib/backlog_kit/client/group.rb', line 11

def get_groups(params = {})
  get('groups', params)
end

#update_group(group_id, params = {}) ⇒ BacklogKit::Response

Update a group

Parameters:

  • group_id (Integer, String) —

    Group id

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

    Request parameters

Returns:



38
39
40
 
# File 'lib/backlog_kit/client/group.rb', line 38

def update_group(group_id, params = {})
  patch("groups/#{group_id}", params)
end