Module: BWAPI::Client::Projects::Group::LocationGroup

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

Overview

LocationGroup module for projects/group/location endpoints

Instance Method Summary collapse

Instance Method Details

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

Create a new location 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

  • location (Array) —

    The location in the group

Returns:

  • (Hash) —

    New location group



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

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

#delete_location_group(project_id, location_group_id) ⇒ Hash

Delete an existing location group project

Parameters:

  • project_id (Integer) —

    Id of project

  • location_group_id (Integer) —

    Id of location group

Returns:

  • (Hash) —

    Deleted location group



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

def delete_location_group(project_id, location_group_id)
  delete "projects/#{project_id}/group/location/#{location_group_id}"
end

#get_location_group(project_id, location_group_id) ⇒ Hash

Get a specific location group in project

Parameters:

  • project_id (Integer) —

    Id of project

  • location_group_id (Integer) —

    Id of location group

Returns:

  • (Hash) —

    Specific location group



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

def get_location_group(project_id, location_group_id)
  get "projects/#{project_id}/group/location/#{location_group_id}"
end

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

Get summary of all location groups in project

Parameters:

  • project_id (Integer) —

    Id of project

Returns:

  • (Hash) —

    Summary of all location groups in project



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

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

#update_location_group(project_id, location_group_id, opts = {}) ⇒ Hash

Update an existing location group in project

Parameters:

  • project_id (Integer) —

    Id of project

  • location_group_id (Integer) —

    Id of location 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

  • location (Array) —

    The location in the group

Returns:

  • (Hash) —

    Updated location group



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

def update_location_group(project_id, location_group_id, opts = {})
  put "projects/#{project_id}/group/location/#{location_group_id}", opts
end