Module: BWAPI::Client::Projects::Group::SiteGroup

Included in:
BWAPI::Client::Projects::Group
Defined in:
lib/bwapi/client/projects/group/site_group.rb

Overview

SiteGroup module for projects/group/site endpoints

Instance Method Summary collapse

Instance Method Details

#create_site_group(project_id, opts = {}) ⇒ Hash

Create a new site group in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • name (String) —

    The human readable name for the group

  • userId (Integer) —

    The id of the creating user

  • sharedProjectIds (Array) —

    The ids of the shared projects

  • shared (String) —

    The type of sharing for the group

  • sites (Array) —

    The sites in the group

Returns:

  • (Hash) —

    New site group



34
35
36
 
# File 'lib/bwapi/client/projects/group/site_group.rb', line 34

def create_site_group(project_id, opts = {})
  post "projects/#{project_id}/group/site", opts
end

#delete_site_group(project_id, site_group_id) ⇒ Hash

Delete an existing site group project

Parameters:

  • project_id (Integer) —

    Id of project

  • site_group_id (Integer) —

    Id of site group

Returns:

  • (Hash) —

    Deleted site group



59
60
61
 
# File 'lib/bwapi/client/projects/group/site_group.rb', line 59

def delete_site_group(project_id, site_group_id)
  delete "projects/#{project_id}/group/site/#{site_group_id}"
end

#get_site_group(project_id, site_group_id) ⇒ Hash

Get a specific site group in project

Parameters:

  • project_id (Integer) —

    Id of project

  • site_group_id (Integer) —

    Id of site group

Returns:

  • (Hash) —

    Specific site group



20
21
22
 
# File 'lib/bwapi/client/projects/group/site_group.rb', line 20

def get_site_group(project_id, site_group_id)
  get "projects/#{project_id}/group/site/#{site_group_id}"
end

#site_groups_summary(project_id, opts = {}) ⇒ Hash

Get summary of all site groups in project

Parameters:

  • project_id (Integer) —

    Id of project

Returns:

  • (Hash) —

    Summary of all site groups in project



11
12
13
 
# File 'lib/bwapi/client/projects/group/site_group.rb', line 11

def site_groups_summary(project_id, opts = {})
  get "projects/#{project_id}/group/site/summary", opts
end

#update_site_group(project_id, site_group_id, opts = {}) ⇒ Hash

Update an existing site group in project

Parameters:

  • project_id (Integer) —

    Id of project

  • site_group_id (Integer) —

    Id of site group

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

    options hash of parameter

Options Hash (opts):

  • id (Integer) —

    The id of the group

  • name (String) —

    The human readable name for the group

  • userId (Integer) —

    The id of the creating user

  • sharedProjectIds (Array) —

    The ids of the shared projects

  • shared (String) —

    The type of sharing for the group

  • sites (Array) —

    The sites in the group

Returns:

  • (Hash) —

    Updated site group



50
51
52
 
# File 'lib/bwapi/client/projects/group/site_group.rb', line 50

def update_site_group(project_id, site_group_id, opts = {})
  put "projects/#{project_id}/group/site/#{site_group_id}", opts
end