module BWAPI::Client::Projects::Group::AuthorGroup

AuthorGroup module for projects/group/author endpoints

Public Instance Methods

author_groups_summary(project_id, opts = {}) click to toggle source

Get summary of all author groups in project

@param project_id [Integer] Id of project @return [Hash] Summary of all author groups in project

# File lib/bwapi/client/projects/group/author_group.rb, line 11
def author_groups_summary(project_id, opts = {})
  get "projects/#{project_id}/group/author/summary", opts
end
create_author_group(project_id, opts = {}) click to toggle source

Create a new author group in project

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [String] name The human readable name for the group @option opts [Integer] userId The id of the creating user @option opts [Array] sharedProjectIds The ids of the shared projects @option opts [String] shared The type of sharing for the group @option opts [Array] authors The authors in the group @return [Hash] New author group

# File lib/bwapi/client/projects/group/author_group.rb, line 34
def create_author_group(project_id, opts = {})
  post "projects/#{project_id}/group/author", opts
end
delete_author_group(project_id, author_group_id) click to toggle source

Delete an existing author group project

@param project_id [Integer] Id of project @param author_group_id [Integer] Id of author group @return [Hash] Deleted author group

# File lib/bwapi/client/projects/group/author_group.rb, line 59
def delete_author_group(project_id, author_group_id)
  delete "projects/#{project_id}/group/author/#{author_group_id}"
end
get_author_group(project_id, author_group_id) click to toggle source

Get a specific author group in project

@param project_id [Integer] Id of project @param author_group_id [Integer] Id of author group @return [Hash] Specific author group

# File lib/bwapi/client/projects/group/author_group.rb, line 20
def get_author_group(project_id, author_group_id)
  get "projects/#{project_id}/group/author/#{author_group_id}"
end
update_author_group(project_id, author_group_id, opts = {}) click to toggle source

Update an existing author group in project

@param project_id [Integer] Id of project @param author_group_id [Integer] Id of author group @param opts [Hash] options hash of parameter @option opts [Integer] id The id of the group @option opts [String] name The human readable name for the group @option opts [Integer] userId The id of the creating user @option opts [Array] sharedProjectIds The ids of the shared projects @option opts [String] shared The type of sharing for the group @option opts [Array] authors The authors in the group @return [Hash] Updated author group

# File lib/bwapi/client/projects/group/author_group.rb, line 50
def update_author_group(project_id, author_group_id, opts = {})
  put "projects/#{project_id}/group/author/#{author_group_id}", opts
end