Module: CleverSDK::Api::Schools

Included in:
CleverSDK::Api
Defined in:
lib/clever_sdk/api/schools.rb

Instance Method Summary collapse

Instance Method Details

#school(access_token:, id:) ⇒ Object 



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

def school(access_token:, id:)
  get(
    "https://api.clever.com/v3.0/schools/#{id}",
    {},
    bearer_headers(access_token)
  )
end

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



23
24
25
26
27
28
29
 
# File 'lib/clever_sdk/api/schools.rb', line 23

def school_courses(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
  get(
    "https://api.clever.com/v3.0/schools/#{id}/courses",
    params(limit: limit, starting_after: starting_after, ending_before: ending_before),
    bearer_headers(access_token)
  )
end

#school_district(access_token:, id:) ⇒ Object 



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

def school_district(access_token:, id:)
  get(
    "https://api.clever.com/v3.0/schools/#{id}/district",
    {},
    bearer_headers(access_token)
  )
end

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



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

def school_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
  get(
    "https://api.clever.com/v3.0/schools/#{id}/sections",
    params(limit: limit, starting_after: starting_after, ending_before: ending_before),
    bearer_headers(access_token)
  )
end

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



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

def school_terms(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
  get(
    "https://api.clever.com/v3.0/schools/#{id}/terms",
    params(limit: limit, starting_after: starting_after, ending_before: ending_before),
    bearer_headers(access_token)
  )
end

#school_users(access_token:, 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



57
58
59
60
61
62
63
64
 
# File 'lib/clever_sdk/api/schools.rb', line 57

def school_users(access_token:, id:, role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
  get(
    "https://api.clever.com/v3.0/schools/#{id}/users",
    params(role: role, primary: primary,
      limit: limit, starting_after: starting_after, ending_before: ending_before),
    bearer_headers(access_token)
  )
end

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

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



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

def schools(access_token:, limit: nil, starting_after: nil, ending_before: nil, count: nil)
  get(
    "https://api.clever.com/v3.0/schools",
    params(limit: limit, starting_after: starting_after, ending_before: ending_before, count: count),
    bearer_headers(access_token)
  )
end