Module: CleverSDK::Api::Terms

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

Instance Method Summary collapse

Instance Method Details

#term(access_token:, id:) ⇒ Object 



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

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

#term_district(access_token:, id:) ⇒ Object 



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

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

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



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

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

#term_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/terms.rb', line 39

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

#terms(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/terms.rb', line 7

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