module BusinessInsightApiClient::Api::Groups

Groups API based methods. This module contains methods to query the Groups API.

Public Instance Methods

create_group(group = {}) click to toggle source

post: '/groups' @param [Hash] group ({}) group to be created. See docs for parameters. @see api.nedap-bi.com/api/docs/

# File lib/business_insight_api_client/api/groups.rb, line 23
def create_group(group = {})
  ::BusinessInsightApiClient::Mash.from_json client.post('/groups', group.to_json)
end
group(id) click to toggle source

get: '/groups/:id' @param [Integer] id group id @see api.nedap-bi.com/api/docs/

# File lib/business_insight_api_client/api/groups.rb, line 16
def group(id)
  ::BusinessInsightApiClient::Mash.from_json client.get("/groups/#{id}")
end
groups() click to toggle source

get: '/groups' @see api.nedap-bi.com/api/docs/

# File lib/business_insight_api_client/api/groups.rb, line 9
def groups
  ::BusinessInsightApiClient::Mash.from_json client.get('/groups')
end
update_group(group_id, group = {}) click to toggle source

put: '/groups/:group_id' @param [Integer] group_id group to be updated. @param [Hash] group ({}) parameters to be updated. See docs for parameters. @see api.nedap-bi.com/api/docs/

# File lib/business_insight_api_client/api/groups.rb, line 31
def update_group(group_id, group = {})
  ::BusinessInsightApiClient::Mash.from_json client.put("/groups/#{group_id}", group.to_json)
end