Class: CleverSDK::Api

Inherits:
Object
  • Object
show all
Includes:
Authentication, Courses, Districts, Events, Resources, Schools, Sections, Terms, Users
Defined in:
lib/clever_sdk/api.rb,
lib/clever_sdk/api/terms.rb,
lib/clever_sdk/api/users.rb,
lib/clever_sdk/api/events.rb,
lib/clever_sdk/api/courses.rb,
lib/clever_sdk/api/schools.rb,
lib/clever_sdk/api/response.rb,
lib/clever_sdk/api/sections.rb,
lib/clever_sdk/api/districts.rb,
lib/clever_sdk/api/resources.rb,
lib/clever_sdk/api/authentication.rb

Overview

private CleverSDK::Api is only responsible for making requests to Clever API. CleverSDK::Api is not responsible for managing authentication state. CleverSDK::Api is not responsible for specifying/using configured values. CleverSDK::Api is not responsible for iterating across multiple Clever API requests.

Defined Under Namespace

Modules: Authentication, Courses, Districts, Events, Resources, Schools, Sections, Terms, Users Classes: Response

Instance Method Summary collapse

Methods included from Events

#event, #events

Methods included from Users

#user, #user_district, #user_mycontacts, #user_mystudents, #user_myteachers, #user_resources, #user_schools, #user_sections, #users

Methods included from Terms

#term, #term_district, #term_schools, #term_sections, #terms

Methods included from Sections

#section, #section_course, #section_district, #section_resources, #section_school, #section_term, #section_users, #sections

Methods included from Schools

#school, #school_courses, #school_district, #school_sections, #school_terms, #school_users, #schools

Methods included from Resources

#resource, #resource_courses, #resource_sections, #resource_users, #resources

Methods included from Districts

#district, #districts

Methods included from Courses

#course, #course_district, #course_resources, #course_schools, #course_sections, #courses

Methods included from Authentication

#me, #tokeninfo, #tokens, #tokens!

Instance Method Details

#page(access_token:, path:) ⇒ Object

internal



36
37
38
39
40
41
42
 
# File 'lib/clever_sdk/api.rb', line 36

def page(access_token:, path:)
  get(
    "https://api.clever.com#{path}",
    {},
    bearer_headers(access_token)
  )
end