module BWAPI::Client::Projects::Signals::Groups

Groups module for projects/signals/groups endpoint

Public Instance Methods

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

Create a new signal group

@param projectId [Integer] Project ID of the Signal Group to be updated @param opts [Hash] options hash of parameters @option opts [Integer] projectId Project ID of Signal Group @option opts [Array] queryIds List of query IDs in the Signal Group @option opts [String] name Name of the Signal Group @option opts [Array] subscribers List of the email recipients of the Signal Group @option opts [Date] lastModified Last modified date of the Signal Group @option opts [Integer] id ID of Signal Group @option opts [String] creator Creator of the Signal Group @return [Hash] Retuns the new signal group

# File lib/bwapi/client/projects/signals/groups.rb, line 39
def create_signal_group(project_id, opts = {})
  post "/projects/#{project_id}/signals/groups", opts
end
delete_signal_group(project_id, group_id) click to toggle source

Delete a signal group

@param projectId [Integer] Id of project @param groupId [Integer] Id of group @return [Hash] Returns the deleted signal group

# File lib/bwapi/client/projects/signals/groups.rb, line 65
def delete_signal_group(project_id, group_id)
  delete "/projects/#{project_id}/signals/groups/#{group_id}"
end
get_signal_group(project_id, group_id) click to toggle source

Get a specific signal group

@param projectId [Integer] Id of project @param groupId [Integer] Id of group @return [Hash] Returns a specific signals group

# File lib/bwapi/client/projects/signals/groups.rb, line 23
def get_signal_group(project_id, group_id)
  get "/projects/#{project_id}/signals/groups/#{group_id}"
end
get_signal_group_signals(project_id, group_id) click to toggle source

Get all signals for a specific group

@param projectId [Integer] Id of project @param groupId [Integer] Id of group @return [Hash] Returns a specific signal group signals

# File lib/bwapi/client/projects/signals/groups.rb, line 74
def get_signal_group_signals(project_id, group_id)
  get "/projects/#{project_id}/signals/groups/#{group_id}/signals"
end
signal_groups(project_id, opts = {}) click to toggle source

Get all signal groups @param projectId [Integer] Id of the existing project @option opts [Integer] page Page of results to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] Returns All signal groups for project

# File lib/bwapi/client/projects/signals/groups.rb, line 14
def signal_groups(project_id, opts = {})
  get "/projects/#{project_id}/signals/groups", opts
end
update_signal_group(project_id, group_id, opts = {}) click to toggle source

Update a signal group

@param projectId [Integer] Project ID of the Signal Group to be updated @param groupId [Integer] Id of group @param opts [Hash] options hash of parameters @option opts [Integer] projectId Project ID of Signal Group @option opts [Array] queryIds List of query IDs in the Signal Group @option opts [String] name Name of the Signal Group @option opts [Array] subscribers List of the email recipients of the Signal Group @option opts [Date] lastModified Last modified date of the Signal Group @option opts [Integer] id ID of Signal Group @option opts [String] creator Creator of the Signal Group @return [Hash] Returns the updated signal group

# File lib/bwapi/client/projects/signals/groups.rb, line 56
def update_signal_group(project_id, group_id, opts = {})
  put "/projects/#{project_id}/signals/groups/#{group_id}", opts
end