Class: CleverSDK::Data::School::Refs

Inherits:
Object
  • Object
show all
Defined in:
lib/clever_sdk/data/school/refs.rb

Instance Method Summary collapse

Constructor Details

#initialize(school) ⇒ Refs

private



8
9
10
 
# File 'lib/clever_sdk/data/school/refs.rb', line 8

def initialize(school)
  @school = school
end

Instance Method Details

#courses(limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



12
13
14
 
# File 'lib/clever_sdk/data/school/refs.rb', line 12

def courses(limit: nil, starting_after: nil, ending_before: nil)
  client.school_courses(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
end

#district ⇒ Object 



16
17
18
 
# File 'lib/clever_sdk/data/school/refs.rb', line 16

def district
  client.school_district(@school.id)
end

#sections(limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



20
21
22
 
# File 'lib/clever_sdk/data/school/refs.rb', line 20

def sections(limit: nil, starting_after: nil, ending_before: nil)
  client.school_sections(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
end

#terms(limit: nil, starting_after: nil, ending_before: nil) ⇒ Object 



24
25
26
 
# File 'lib/clever_sdk/data/school/refs.rb', line 24

def terms(limit: nil, starting_after: nil, ending_before: nil)
  client.school_terms(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
end

#users(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



30
31
32
 
# File 'lib/clever_sdk/data/school/refs.rb', line 30

def users(role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
  client.school_users(@school.id, role: role, primary: primary, limit: limit, starting_after: starting_after, ending_before: ending_before)
end