Module: CleverSDK::Api::Users

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

Instance Method Summary collapse

Instance Method Details

#user(access_token:, id:) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/clever_sdk/api/users.rb', line 17

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

#user_district(access_token:, id:) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/clever_sdk/api/users.rb', line 25

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

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



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

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

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



66
67
68
69
70
71
72
 
# File 'lib/clever_sdk/api/users.rb', line 66

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

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



74
75
76
77
78
79
80
 
# File 'lib/clever_sdk/api/users.rb', line 74

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

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



33
34
35
36
37
38
39
 
# File 'lib/clever_sdk/api/users.rb', line 33

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

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

primary - acceptable values are nil, true



42
43
44
45
46
47
48
 
# File 'lib/clever_sdk/api/users.rb', line 42

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

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



50
51
52
53
54
55
56
 
# File 'lib/clever_sdk/api/users.rb', line 50

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

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

role - acceptable values are nil, :contact, :district_admin, :staff, :student, :teacher count - acceptable values are nil, :true, :false, :undefined



8
9
10
11
12
13
14
15
 
# File 'lib/clever_sdk/api/users.rb', line 8

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