Module: CleverSDK::Client::Users

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

Instance Method Summary collapse

Instance Method Details

#user(id) ⇒ Object 



16
17
18
19
20
 
# File 'lib/clever_sdk/client/users.rb', line 16

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

#user_district(id) ⇒ Object 



22
23
24
25
26
 
# File 'lib/clever_sdk/client/users.rb', line 22

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

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



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

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

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



53
54
55
56
57
 
# File 'lib/clever_sdk/client/users.rb', line 53

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

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



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

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

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



28
29
30
31
32
 
# File 'lib/clever_sdk/client/users.rb', line 28

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

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

primary - acceptable values are nil, true



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

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

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



41
42
43
44
45
 
# File 'lib/clever_sdk/client/users.rb', line 41

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

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



10
11
12
13
14
 
# File 'lib/clever_sdk/client/users.rb', line 10

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