Module: CleverSDK::Client::Schools

Included in:
CleverSDK::Client
Defined in:
lib/clever_sdk/client/schools.rb

Instance Method Summary collapse

Instance Method Details

#school(id) ⇒ Object 



15
16
17
18
19
 
# File 'lib/clever_sdk/client/schools.rb', line 15

def school(id)
  response = api.school(access_token: access_token, id: id)
  data = response.body.dig("data")
  CleverSDK::Data::School.new(data, response)
end

#school_courses(id, limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



21
22
23
24
25
 
# File 'lib/clever_sdk/client/schools.rb', line 21

def school_courses(id, limit: nil, starting_after: nil, ending_before: nil)
  response = api.school_courses(access_token: access_token, id: id,
    limit: limit, starting_after: starting_after, ending_before: ending_before)
  CleverSDK::Data::Courses.new(response)
end

#school_district(id) ⇒ Object 



27
28
29
30
31
 
# File 'lib/clever_sdk/client/schools.rb', line 27

def school_district(id)
  response = api.school_district(access_token: access_token, id: id)
  data = response.body.dig("data")
  CleverSDK::Data::District.new(data, response)
end

#school_sections(id, limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



33
34
35
36
37
 
# File 'lib/clever_sdk/client/schools.rb', line 33

def school_sections(id, limit: nil, starting_after: nil, ending_before: nil)
  response = api.school_sections(access_token: access_token, id: id,
    limit: limit, starting_after: starting_after, ending_before: ending_before)
  CleverSDK::Data::Sections.new(response)
end

#school_terms(id, limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



39
40
41
42
43
 
# File 'lib/clever_sdk/client/schools.rb', line 39

def school_terms(id, limit: nil, starting_after: nil, ending_before: nil)
  response = api.school_terms(access_token: access_token, id: id,
    limit: limit, starting_after: starting_after, ending_before: ending_before)
  CleverSDK::Data::Terms.new(response)
end

#school_users(id, role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil) ⇒ Object

role - acceptable values are nil, :staff, :student, :teacher primary - acceptable values are nil, true



47
48
49
50
51
 
# File 'lib/clever_sdk/client/schools.rb', line 47

def school_users(id, role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
  response = api.school_users(access_token: access_token, id: id, role: role, primary: primary,
    limit: limit, starting_after: starting_after, ending_before: ending_before)
  CleverSDK::Data::Users.new(response)
end

#schools(limit: nil, starting_after: nil, ending_before: nil, count: nil) ⇒ Object

count - acceptable values are nil, :true, :false, :undefined



9
10
11
12
13
 
# File 'lib/clever_sdk/client/schools.rb', line 9

def schools(limit: nil, starting_after: nil, ending_before: nil, count: nil)
  response = api.schools(access_token: access_token,
    limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
  CleverSDK::Data::Schools.new(response)
end