Class: LessonlyApi::Groups

Inherits:
Request show all
Defined in:
lib/lessonly_api/groups.rb

Class Method Summary collapse

Methods inherited from Request

client

Methods inherited from ResourceType::Base

#attributes, dump, fields, from_json, #initialize, load

Constructor Details

This class inherits a constructor from LessonlyApi::ResourceType::Base

Class Method Details

.archive(id) ⇒ ResourceType::Group

Archive a group docs.lessonly.com/#archive-group

Parameters:

  • id (Integer) —

    ID of a group to archive

Returns:



49
50
51
52
 
# File 'lib/lessonly_api/groups.rb', line 49

def archive(id)
  raw_result = send_put("/groups/#{id}/archive")
  ResourceType::Group.new(raw_result)
end

.create(attributes = {}) ⇒ ResourceType::Group

Create a group docs.lessonly.com/#create-group

Parameters:

  • attributes (Hash) (defaults to: {}) —

    hash with group’s attributes

Returns:



28
29
30
31
 
# File 'lib/lessonly_api/groups.rb', line 28

def create(attributes = {})
  raw_result = send_post('/groups', attributes)
  ResourceType::Group.new(raw_result)
end

.delete(id) ⇒ ResourceType::Group

Delete a group docs.lessonly.com/#delete-group

Parameters:

  • id (Integer) —

    ID of a group to delete

Returns:



69
70
71
72
 
# File 'lib/lessonly_api/groups.rb', line 69

def delete(id)
  raw_result = send_delete("/groups/#{id}")
  ResourceType::Group.new(raw_result)
end

.group_assignments(id) ⇒ ResourceType::GroupAssignments

Return a list of assignments for a given group docs.lessonly.com/#group-assignments

Parameters:

  • id (Integer) —

    ID of a group

Returns:

  • (ResourceType::GroupAssignments) —

    the response converted to a resource object



79
80
81
82
 
# File 'lib/lessonly_api/groups.rb', line 79

def group_assignments(id)
  raw_result = send_get("/groups/#{id}/assignments")
  raw_result.map { |el| ResourceType::GroupAssignment.new(el) }
end

.list ⇒ ResourceType::Groups

Retrieve all groups docs.lessonly.com/#list-groups

Returns:



8
9
10
11
 
# File 'lib/lessonly_api/groups.rb', line 8

def list
  raw_result = send_get('/groups')
  LessonlyApi::ResourceType::Groups.new(raw_result)
end

.restore(id) ⇒ ResourceType::Group

Restore an archived group docs.lessonly.com/#restore-group

Parameters:

  • id (Integer) —

    ID of a group to restore

Returns:



59
60
61
62
 
# File 'lib/lessonly_api/groups.rb', line 59

def restore(id)
  raw_result = send_put("/groups/#{id}/restore")
  ResourceType::Group.new(raw_result)
end

.show(id) ⇒ ResourceType::Group

Retrieve a listing of a groups members and managers. docs.lessonly.com/#show-group-details

Parameters:

  • id (Integer) —

    ID of the group

Returns:



18
19
20
21
 
# File 'lib/lessonly_api/groups.rb', line 18

def show(id)
  raw_result = send_get("/groups/#{id}")
  LessonlyApi::ResourceType::Group.new(raw_result)
end

.update(id, attributes = {}) ⇒ ResourceType::Group

Update a group docs.lessonly.com/#update-group

Parameters:

  • id (Integer) —

    ID of a group to update

  • attributes (Hash) (defaults to: {}) —

    hash with group’s attributes to update

Returns:



39
40
41
42
 
# File 'lib/lessonly_api/groups.rb', line 39

def update(id, attributes = {})
  raw_result = send_put("/groups/#{id}", attributes)
  ResourceType::Group.new(raw_result)
end