Class: LessonlyApi::Users

Inherits:
Request show all
Defined in:
lib/lessonly_api/users.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) ⇒ Object 



24
25
26
27
 
# File 'lib/lessonly_api/users.rb', line 24

def archive(id)
  raw_result = put("/users/#{id}/archive")
  ResourceType::User.new(raw_result)
end

.create(attributes = {}) ⇒ Object 



14
15
16
17
 
# File 'lib/lessonly_api/users.rb', line 14

def create(attributes = {})
  raw_result = post("/users", attributes)
  ResourceType::User.new(raw_result)
end

.create_user_assignments(id, assignments = []) ⇒ Object 



55
56
57
58
 
# File 'lib/lessonly_api/users.rb', line 55

def create_user_assignments(id, assignments = [])
  raw_result = put("/users/#{id}/assignments", assignments: assignments)
  ResourceType::UserAssignments.new(raw_result)
end

.destroy(id) ⇒ Object

TODO: i.kamenko method name should be delete probably



35
36
37
38
 
# File 'lib/lessonly_api/users.rb', line 35

def destroy(id)
  raw_result = delete("/users/#{id}")
  ResourceType::User.new(raw_result)
end

.list(page: 1, per_page: 50, **filters) ⇒ Object 



4
5
6
7
 
# File 'lib/lessonly_api/users.rb', line 4

def list(page: 1, per_page: 50, **filters)
  raw_result = get('/users', page: page, per_page: per_page, filter: filters)
  ResourceType::Users.new(raw_result)
end

.restore(id) ⇒ Object 



29
30
31
32
 
# File 'lib/lessonly_api/users.rb', line 29

def restore(id)
  raw_result = put("/users/#{id}/restore")
  ResourceType::User.new(raw_result)
end

.show(id) ⇒ Object 



9
10
11
12
 
# File 'lib/lessonly_api/users.rb', line 9

def show(id)
  raw_result = get("/users/#{id}")
  LessonlyApi::ResourceType::User.new(raw_result)
end

.update(id, attributes = {}) ⇒ Object 



19
20
21
22
 
# File 'lib/lessonly_api/users.rb', line 19

def update(id, attributes = {})
  raw_result = put("/users/#{id}", attributes)
  ResourceType::User.new(raw_result)
end

.update_user_groups(id, attributes = {}) ⇒ Object 



45
46
47
48
 
# File 'lib/lessonly_api/users.rb', line 45

def update_user_groups(id, attributes = {})
  raw_result = put("/users/#{id}/groups", attributes)
  ResourceType::UserGroup.new(raw_result)
end

.user_assignments(id) ⇒ Object 



50
51
52
53
 
# File 'lib/lessonly_api/users.rb', line 50

def user_assignments(id)
  raw_result = get("/users/#{id}/assignments")
  ResourceType::UserAssignments.new(raw_result)
end

.user_groups(id) ⇒ Object 



40
41
42
43
 
# File 'lib/lessonly_api/users.rb', line 40

def user_groups(id)
  raw_result = get("/users/#{id}/groups")
  ResourceType::UserGroup.new(raw_result)
end