Module: Emma::API::Groups

Included in:
Client
Defined in:
lib/emma/api/groups.rb

Instance Method Summary collapse

Instance Method Details

#add_members_to_group(id, params = {}) ⇒ Object

Add a list of members to a single active member group.



37
38
39
 
# File 'lib/emma/api/groups.rb', line 37

def add_members_to_group(id, params = {})
  put("/groups/#{id}/members", params)
end

#add_new_groups(params = {}) ⇒ Object

Create one or more new member groups.



12
13
14
 
# File 'lib/emma/api/groups.rb', line 12

def add_new_groups(params = {})
  post("/groups", params)
end

#copy_members_to_different_group(from_id, to_id, params = {}) ⇒ Object

Copy all the users of one group into another group.



57
58
59
 
# File 'lib/emma/api/groups.rb', line 57

def copy_members_to_different_group(from_id, to_id, params = {})
  put("/groups/#{from_id}/#{to_id}/members/copy", params)
end

#get_group_by_id(id) ⇒ Object

Get the detailed information for a single member group.



17
18
19
 
# File 'lib/emma/api/groups.rb', line 17

def get_group_by_id(id)
  get("/groups/#{id}")
end

#group_members(id, params = {}) ⇒ Object

Get the members in a single active member group.



32
33
34
 
# File 'lib/emma/api/groups.rb', line 32

def group_members(id, params = {})
  get("/groups/#{id}/members", params)
end

#my_groups(params = {}) ⇒ Object

Get a basic listing of all active member groups for a single account.



7
8
9
 
# File 'lib/emma/api/groups.rb', line 7

def my_groups(params = {})
  get("/groups", params)
end

#remove_all_members_from_group(id, params = {}) ⇒ Object

Remove all members from a single active member group.



47
48
49
 
# File 'lib/emma/api/groups.rb', line 47

def remove_all_members_from_group(id, params = {})
  delete("/groups/#{id}/members", params)
end

#remove_all_members_from_groups(id, params = {}) ⇒ Object

Remove all members from all active member groups as a background job. The member_status_id parameter must be set.



52
53
54
 
# File 'lib/emma/api/groups.rb', line 52

def remove_all_members_from_groups(id, params = {})
  delete("/groups/#{id}/members/remove", params)
end

#remove_group(id) ⇒ Object

Delete a single member group.



27
28
29
 
# File 'lib/emma/api/groups.rb', line 27

def remove_group(id)
  delete("/groups/#{id}")
end

#remove_members_from_group(id, params = {}) ⇒ Object

Remove members from a single active member group.



42
43
44
 
# File 'lib/emma/api/groups.rb', line 42

def remove_members_from_group(id, params = {})
  put("/groups/#{id}/members/remove", params)
end

#update_group(id, params = {}) ⇒ Object

Update information for a single member group.



22
23
24
 
# File 'lib/emma/api/groups.rb', line 22

def update_group(id, params = {})
  put("/groups/#{id}", params)
end