Module: Emma::API::Searches

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

Instance Method Summary collapse

Instance Method Details

#create_search(params = {}) ⇒ Object

Create a saved search.



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

def create_search(params = {})
  post("/searches", params)
end

#get_members_of_search(id) ⇒ Object

Get the members matching the search.



33
34
35
 
# File 'lib/emma/api/searches.rb', line 33

def get_members_of_search(id)
  get("/searches/#{id}/members")
end

#my_searches(params = {}) ⇒ Object

Retrieve a list of saved searches.



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

def my_searches(params = {})
  get("/searches", params)
end

#remove_search(id) ⇒ Object

Delete a saved search. The member records referred to by the search are not affected.



28
29
30
 
# File 'lib/emma/api/searches.rb', line 28

def remove_search(id)
  delete("/searches/#{id}")
end

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

Get the details for a saved search.



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

def single_search(id, params = {})
  get("/searches/#{id}", params)
end

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

Update a saved search. No parameters are required, but either the name or criteria parameter must be present for an update to occur.



23
24
25
 
# File 'lib/emma/api/searches.rb', line 23

def update_search(id, params = {})
  put("/searches/#{id}", params)
end