commonlit-clever-ruby 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +129 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +73 -0
  5. data/LICENSE +190 -0
  6. data/Makefile +10 -0
  7. data/README.md +265 -0
  8. data/Rakefile +8 -0
  9. data/clever-ruby.gemspec +46 -0
  10. data/docs/AdminName.md +9 -0
  11. data/docs/BadRequest.md +8 -0
  12. data/docs/Contact.md +17 -0
  13. data/docs/ContactObject.md +8 -0
  14. data/docs/ContactResponse.md +8 -0
  15. data/docs/ContactsCreated.md +11 -0
  16. data/docs/ContactsDeleted.md +11 -0
  17. data/docs/ContactsResponse.md +9 -0
  18. data/docs/ContactsUpdated.md +12 -0
  19. data/docs/Course.md +11 -0
  20. data/docs/CourseObject.md +8 -0
  21. data/docs/CourseResponse.md +8 -0
  22. data/docs/CoursesCreated.md +11 -0
  23. data/docs/CoursesDeleted.md +11 -0
  24. data/docs/CoursesResponse.md +9 -0
  25. data/docs/CoursesUpdated.md +12 -0
  26. data/docs/Credentials.md +8 -0
  27. data/docs/DataApi.md +2852 -0
  28. data/docs/District.md +21 -0
  29. data/docs/DistrictAdmin.md +12 -0
  30. data/docs/DistrictAdminObject.md +8 -0
  31. data/docs/DistrictAdminResponse.md +8 -0
  32. data/docs/DistrictAdminsResponse.md +9 -0
  33. data/docs/DistrictObject.md +8 -0
  34. data/docs/DistrictResponse.md +8 -0
  35. data/docs/DistrictadminsCreated.md +11 -0
  36. data/docs/DistrictadminsDeleted.md +11 -0
  37. data/docs/DistrictadminsUpdated.md +12 -0
  38. data/docs/DistrictsCreated.md +11 -0
  39. data/docs/DistrictsDeleted.md +11 -0
  40. data/docs/DistrictsResponse.md +9 -0
  41. data/docs/DistrictsUpdated.md +12 -0
  42. data/docs/Event.md +10 -0
  43. data/docs/EventResponse.md +8 -0
  44. data/docs/EventsApi.md +121 -0
  45. data/docs/EventsResponse.md +9 -0
  46. data/docs/InternalError.md +8 -0
  47. data/docs/Link.md +9 -0
  48. data/docs/Location.md +13 -0
  49. data/docs/Name.md +10 -0
  50. data/docs/NotFound.md +8 -0
  51. data/docs/Principal.md +9 -0
  52. data/docs/School.md +23 -0
  53. data/docs/SchoolAdmin.md +17 -0
  54. data/docs/SchoolAdminObject.md +8 -0
  55. data/docs/SchoolAdminResponse.md +8 -0
  56. data/docs/SchoolAdminsResponse.md +9 -0
  57. data/docs/SchoolEnrollment.md +10 -0
  58. data/docs/SchoolObject.md +8 -0
  59. data/docs/SchoolResponse.md +8 -0
  60. data/docs/SchooladminsCreated.md +11 -0
  61. data/docs/SchooladminsDeleted.md +11 -0
  62. data/docs/SchooladminsUpdated.md +12 -0
  63. data/docs/SchoolsCreated.md +11 -0
  64. data/docs/SchoolsDeleted.md +11 -0
  65. data/docs/SchoolsResponse.md +9 -0
  66. data/docs/SchoolsUpdated.md +12 -0
  67. data/docs/Section.md +24 -0
  68. data/docs/SectionObject.md +8 -0
  69. data/docs/SectionResponse.md +8 -0
  70. data/docs/SectionsCreated.md +11 -0
  71. data/docs/SectionsDeleted.md +11 -0
  72. data/docs/SectionsResponse.md +9 -0
  73. data/docs/SectionsUpdated.md +12 -0
  74. data/docs/Student.md +33 -0
  75. data/docs/StudentObject.md +8 -0
  76. data/docs/StudentResponse.md +8 -0
  77. data/docs/StudentsCreated.md +11 -0
  78. data/docs/StudentsDeleted.md +11 -0
  79. data/docs/StudentsResponse.md +9 -0
  80. data/docs/StudentsUpdated.md +12 -0
  81. data/docs/Teacher.md +21 -0
  82. data/docs/TeacherObject.md +8 -0
  83. data/docs/TeacherResponse.md +8 -0
  84. data/docs/TeachersCreated.md +11 -0
  85. data/docs/TeachersDeleted.md +11 -0
  86. data/docs/TeachersResponse.md +9 -0
  87. data/docs/TeachersUpdated.md +12 -0
  88. data/docs/Term.md +12 -0
  89. data/docs/TermObject.md +8 -0
  90. data/docs/TermResponse.md +8 -0
  91. data/docs/TermsCreated.md +11 -0
  92. data/docs/TermsDeleted.md +11 -0
  93. data/docs/TermsResponse.md +9 -0
  94. data/docs/TermsUpdated.md +12 -0
  95. data/git_push.sh +55 -0
  96. data/lib/clever-ruby.rb +124 -0
  97. data/lib/clever-ruby/api/data_api.rb +2798 -0
  98. data/lib/clever-ruby/api/events_api.rb +132 -0
  99. data/lib/clever-ruby/api_client.rb +414 -0
  100. data/lib/clever-ruby/api_error.rb +38 -0
  101. data/lib/clever-ruby/configuration.rb +209 -0
  102. data/lib/clever-ruby/models/admin_name.rb +193 -0
  103. data/lib/clever-ruby/models/bad_request.rb +184 -0
  104. data/lib/clever-ruby/models/contact.rb +325 -0
  105. data/lib/clever-ruby/models/contact_object.rb +184 -0
  106. data/lib/clever-ruby/models/contact_response.rb +184 -0
  107. data/lib/clever-ruby/models/contacts_created.rb +221 -0
  108. data/lib/clever-ruby/models/contacts_deleted.rb +221 -0
  109. data/lib/clever-ruby/models/contacts_response.rb +197 -0
  110. data/lib/clever-ruby/models/contacts_updated.rb +221 -0
  111. data/lib/clever-ruby/models/course.rb +211 -0
  112. data/lib/clever-ruby/models/course_object.rb +184 -0
  113. data/lib/clever-ruby/models/course_response.rb +184 -0
  114. data/lib/clever-ruby/models/courses_created.rb +221 -0
  115. data/lib/clever-ruby/models/courses_deleted.rb +221 -0
  116. data/lib/clever-ruby/models/courses_response.rb +197 -0
  117. data/lib/clever-ruby/models/courses_updated.rb +221 -0
  118. data/lib/clever-ruby/models/credentials.rb +184 -0
  119. data/lib/clever-ruby/models/district.rb +337 -0
  120. data/lib/clever-ruby/models/district_admin.rb +220 -0
  121. data/lib/clever-ruby/models/district_admin_object.rb +184 -0
  122. data/lib/clever-ruby/models/district_admin_response.rb +184 -0
  123. data/lib/clever-ruby/models/district_admins_response.rb +197 -0
  124. data/lib/clever-ruby/models/district_object.rb +184 -0
  125. data/lib/clever-ruby/models/district_response.rb +184 -0
  126. data/lib/clever-ruby/models/districtadmins_created.rb +221 -0
  127. data/lib/clever-ruby/models/districtadmins_deleted.rb +221 -0
  128. data/lib/clever-ruby/models/districtadmins_updated.rb +221 -0
  129. data/lib/clever-ruby/models/districts_created.rb +221 -0
  130. data/lib/clever-ruby/models/districts_deleted.rb +221 -0
  131. data/lib/clever-ruby/models/districts_response.rb +197 -0
  132. data/lib/clever-ruby/models/districts_updated.rb +221 -0
  133. data/lib/clever-ruby/models/event.rb +207 -0
  134. data/lib/clever-ruby/models/event_response.rb +184 -0
  135. data/lib/clever-ruby/models/events_response.rb +197 -0
  136. data/lib/clever-ruby/models/internal_error.rb +184 -0
  137. data/lib/clever-ruby/models/link.rb +227 -0
  138. data/lib/clever-ruby/models/location.rb +229 -0
  139. data/lib/clever-ruby/models/name.rb +202 -0
  140. data/lib/clever-ruby/models/not_found.rb +184 -0
  141. data/lib/clever-ruby/models/principal.rb +193 -0
  142. data/lib/clever-ruby/models/school.rb +365 -0
  143. data/lib/clever-ruby/models/school_admin.rb +267 -0
  144. data/lib/clever-ruby/models/school_admin_object.rb +184 -0
  145. data/lib/clever-ruby/models/school_admin_response.rb +184 -0
  146. data/lib/clever-ruby/models/school_admins_response.rb +197 -0
  147. data/lib/clever-ruby/models/school_enrollment.rb +202 -0
  148. data/lib/clever-ruby/models/school_object.rb +184 -0
  149. data/lib/clever-ruby/models/school_response.rb +184 -0
  150. data/lib/clever-ruby/models/schooladmins_created.rb +221 -0
  151. data/lib/clever-ruby/models/schooladmins_deleted.rb +221 -0
  152. data/lib/clever-ruby/models/schooladmins_updated.rb +221 -0
  153. data/lib/clever-ruby/models/schools_created.rb +221 -0
  154. data/lib/clever-ruby/models/schools_deleted.rb +221 -0
  155. data/lib/clever-ruby/models/schools_response.rb +197 -0
  156. data/lib/clever-ruby/models/schools_updated.rb +221 -0
  157. data/lib/clever-ruby/models/section.rb +378 -0
  158. data/lib/clever-ruby/models/section_object.rb +184 -0
  159. data/lib/clever-ruby/models/section_response.rb +184 -0
  160. data/lib/clever-ruby/models/sections_created.rb +221 -0
  161. data/lib/clever-ruby/models/sections_deleted.rb +221 -0
  162. data/lib/clever-ruby/models/sections_response.rb +197 -0
  163. data/lib/clever-ruby/models/sections_updated.rb +221 -0
  164. data/lib/clever-ruby/models/student.rb +507 -0
  165. data/lib/clever-ruby/models/student_object.rb +184 -0
  166. data/lib/clever-ruby/models/student_response.rb +184 -0
  167. data/lib/clever-ruby/models/students_created.rb +221 -0
  168. data/lib/clever-ruby/models/students_deleted.rb +221 -0
  169. data/lib/clever-ruby/models/students_response.rb +197 -0
  170. data/lib/clever-ruby/models/students_updated.rb +221 -0
  171. data/lib/clever-ruby/models/teacher.rb +303 -0
  172. data/lib/clever-ruby/models/teacher_object.rb +184 -0
  173. data/lib/clever-ruby/models/teacher_response.rb +184 -0
  174. data/lib/clever-ruby/models/teachers_created.rb +221 -0
  175. data/lib/clever-ruby/models/teachers_deleted.rb +221 -0
  176. data/lib/clever-ruby/models/teachers_response.rb +197 -0
  177. data/lib/clever-ruby/models/teachers_updated.rb +221 -0
  178. data/lib/clever-ruby/models/term.rb +220 -0
  179. data/lib/clever-ruby/models/term_object.rb +184 -0
  180. data/lib/clever-ruby/models/term_response.rb +184 -0
  181. data/lib/clever-ruby/models/terms_created.rb +221 -0
  182. data/lib/clever-ruby/models/terms_deleted.rb +221 -0
  183. data/lib/clever-ruby/models/terms_response.rb +197 -0
  184. data/lib/clever-ruby/models/terms_updated.rb +221 -0
  185. data/lib/clever-ruby/version.rb +15 -0
  186. data/override/README-extension.md +31 -0
  187. data/override/api_client.rb +414 -0
  188. data/override/models/contacts_created.rb +221 -0
  189. data/override/models/contacts_deleted.rb +221 -0
  190. data/override/models/contacts_updated.rb +221 -0
  191. data/override/models/courses_created.rb +221 -0
  192. data/override/models/courses_deleted.rb +221 -0
  193. data/override/models/courses_updated.rb +221 -0
  194. data/override/models/districtadmins_created.rb +221 -0
  195. data/override/models/districtadmins_deleted.rb +221 -0
  196. data/override/models/districtadmins_updated.rb +221 -0
  197. data/override/models/districts_created.rb +221 -0
  198. data/override/models/districts_deleted.rb +221 -0
  199. data/override/models/districts_updated.rb +221 -0
  200. data/override/models/schooladmins_created.rb +221 -0
  201. data/override/models/schooladmins_deleted.rb +221 -0
  202. data/override/models/schooladmins_updated.rb +221 -0
  203. data/override/models/schools_created.rb +221 -0
  204. data/override/models/schools_deleted.rb +221 -0
  205. data/override/models/schools_updated.rb +221 -0
  206. data/override/models/sections_created.rb +221 -0
  207. data/override/models/sections_deleted.rb +221 -0
  208. data/override/models/sections_updated.rb +221 -0
  209. data/override/models/students_created.rb +221 -0
  210. data/override/models/students_deleted.rb +221 -0
  211. data/override/models/students_updated.rb +221 -0
  212. data/override/models/teachers_created.rb +221 -0
  213. data/override/models/teachers_deleted.rb +221 -0
  214. data/override/models/teachers_updated.rb +221 -0
  215. data/override/models/terms_created.rb +221 -0
  216. data/override/models/terms_deleted.rb +221 -0
  217. data/override/models/terms_updated.rb +221 -0
  218. data/override/override.sh +27 -0
  219. data/sample/sample.rb +16 -0
  220. data/spec/api/data_api_spec.rb +671 -0
  221. data/spec/api/events_api_spec.rb +61 -0
  222. data/spec/api_client_spec.rb +226 -0
  223. data/spec/configuration_spec.rb +42 -0
  224. data/spec/events.json +227 -0
  225. data/spec/models/bad_request_spec.rb +41 -0
  226. data/spec/models/contact_object_spec.rb +41 -0
  227. data/spec/models/contact_response_spec.rb +41 -0
  228. data/spec/models/contact_spec.rb +107 -0
  229. data/spec/models/contacts_created_spec.rb +59 -0
  230. data/spec/models/contacts_deleted_spec.rb +59 -0
  231. data/spec/models/contacts_response_spec.rb +41 -0
  232. data/spec/models/contacts_updated_spec.rb +65 -0
  233. data/spec/models/course_object_spec.rb +41 -0
  234. data/spec/models/course_response_spec.rb +41 -0
  235. data/spec/models/course_spec.rb +59 -0
  236. data/spec/models/courses_created_spec.rb +59 -0
  237. data/spec/models/courses_deleted_spec.rb +59 -0
  238. data/spec/models/courses_response_spec.rb +41 -0
  239. data/spec/models/courses_updated_spec.rb +65 -0
  240. data/spec/models/credentials_spec.rb +41 -0
  241. data/spec/models/district_admin_object_spec.rb +41 -0
  242. data/spec/models/district_admin_response_spec.rb +41 -0
  243. data/spec/models/district_admin_spec.rb +65 -0
  244. data/spec/models/district_admins_response_spec.rb +41 -0
  245. data/spec/models/district_object_spec.rb +41 -0
  246. data/spec/models/district_response_spec.rb +41 -0
  247. data/spec/models/district_spec.rb +123 -0
  248. data/spec/models/districtadmins_created_spec.rb +59 -0
  249. data/spec/models/districtadmins_deleted_spec.rb +59 -0
  250. data/spec/models/districtadmins_updated_spec.rb +65 -0
  251. data/spec/models/districts_created_spec.rb +59 -0
  252. data/spec/models/districts_deleted_spec.rb +59 -0
  253. data/spec/models/districts_response_spec.rb +41 -0
  254. data/spec/models/districts_updated_spec.rb +65 -0
  255. data/spec/models/event_response_spec.rb +41 -0
  256. data/spec/models/event_spec.rb +53 -0
  257. data/spec/models/events_response_spec.rb +41 -0
  258. data/spec/models/internal_error_spec.rb +41 -0
  259. data/spec/models/location_spec.rb +71 -0
  260. data/spec/models/name_spec.rb +53 -0
  261. data/spec/models/not_found_spec.rb +41 -0
  262. data/spec/models/principal_spec.rb +47 -0
  263. data/spec/models/school_admin_object_spec.rb +41 -0
  264. data/spec/models/school_admin_response_spec.rb +41 -0
  265. data/spec/models/school_admin_spec.rb +95 -0
  266. data/spec/models/school_admins_response_spec.rb +41 -0
  267. data/spec/models/school_enrollment_spec.rb +53 -0
  268. data/spec/models/school_object_spec.rb +41 -0
  269. data/spec/models/school_response_spec.rb +41 -0
  270. data/spec/models/school_spec.rb +139 -0
  271. data/spec/models/schooladmins_created_spec.rb +59 -0
  272. data/spec/models/schooladmins_deleted_spec.rb +59 -0
  273. data/spec/models/schooladmins_updated_spec.rb +65 -0
  274. data/spec/models/schools_created_spec.rb +59 -0
  275. data/spec/models/schools_deleted_spec.rb +59 -0
  276. data/spec/models/schools_response_spec.rb +41 -0
  277. data/spec/models/schools_updated_spec.rb +65 -0
  278. data/spec/models/section_object_spec.rb +41 -0
  279. data/spec/models/section_response_spec.rb +41 -0
  280. data/spec/models/section_spec.rb +145 -0
  281. data/spec/models/sections_created_spec.rb +59 -0
  282. data/spec/models/sections_deleted_spec.rb +59 -0
  283. data/spec/models/sections_response_spec.rb +41 -0
  284. data/spec/models/sections_updated_spec.rb +65 -0
  285. data/spec/models/student_object_spec.rb +41 -0
  286. data/spec/models/student_response_spec.rb +41 -0
  287. data/spec/models/student_spec.rb +215 -0
  288. data/spec/models/students_created_spec.rb +59 -0
  289. data/spec/models/students_deleted_spec.rb +59 -0
  290. data/spec/models/students_response_spec.rb +41 -0
  291. data/spec/models/students_updated_spec.rb +65 -0
  292. data/spec/models/teacher_object_spec.rb +41 -0
  293. data/spec/models/teacher_response_spec.rb +41 -0
  294. data/spec/models/teacher_spec.rb +119 -0
  295. data/spec/models/teachers_created_spec.rb +59 -0
  296. data/spec/models/teachers_deleted_spec.rb +59 -0
  297. data/spec/models/teachers_response_spec.rb +41 -0
  298. data/spec/models/teachers_updated_spec.rb +65 -0
  299. data/spec/models/term_object_spec.rb +41 -0
  300. data/spec/models/term_response_spec.rb +41 -0
  301. data/spec/models/term_spec.rb +65 -0
  302. data/spec/models/terms_created_spec.rb +59 -0
  303. data/spec/models/terms_deleted_spec.rb +59 -0
  304. data/spec/models/terms_response_spec.rb +41 -0
  305. data/spec/models/terms_updated_spec.rb +65 -0
  306. data/spec/spec_helper.rb +103 -0
  307. data/tags +1681 -0
  308. metadata +636 -0
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,46 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #Clever API
5
+
6
+ #The Clever API
7
+
8
+ OpenAPI spec version: 2.1.0
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 2.4.18
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "clever-ruby/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "commonlit-clever-ruby"
20
+ s.version = Clever::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Swagger-Codegen"]
23
+ s.email = [""]
24
+ s.homepage = "https://github.com/swagger-api/swagger-codegen"
25
+ s.summary = "Clever API Ruby Gem"
26
+ s.description = "The Clever API"
27
+ s.license = "Unlicense"
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+ s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
33
+
34
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
35
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
37
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
40
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
41
+
42
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
43
+ s.test_files = `find spec/*`.split("\n")
44
+ s.executables = []
45
+ s.require_paths = ["lib"]
46
+ end
@@ -0,0 +1,9 @@
1
+ # Clever::AdminName
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **first** | **String** | | [optional]
7
+ **last** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # Clever::BadRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,17 @@
1
+ # Clever::Contact
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **district** | **String** | | [optional]
7
+ **email** | **String** | | [optional]
8
+ **id** | **String** | | [optional]
9
+ **name** | **String** | | [optional]
10
+ **phone** | **String** | | [optional]
11
+ **phone_type** | **String** | | [optional]
12
+ **relationship** | **String** | | [optional]
13
+ **sis_id** | **String** | | [optional]
14
+ **students** | **Array<String>** | | [optional]
15
+ **type** | **String** | | [optional]
16
+
17
+
@@ -0,0 +1,8 @@
1
+ # Clever::ContactObject
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **object** | [**Contact**](Contact.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # Clever::ContactResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Contact**](Contact.md) | | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # Clever::ContactsCreated
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # Clever::ContactsDeleted
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # Clever::ContactsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<ContactResponse>**](ContactResponse.md) | | [optional]
7
+ **links** | [**Array<Link>**](Link.md) | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # Clever::ContactsUpdated
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
+ **previous_attributes** | **Object** | | [optional]
11
+
12
+
@@ -0,0 +1,11 @@
1
+ # Clever::Course
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **district** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **number** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # Clever::CourseObject
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **object** | [**Course**](Course.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # Clever::CourseResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Course**](Course.md) | | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # Clever::CoursesCreated
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**CourseObject**](CourseObject.md) | | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # Clever::CoursesDeleted
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**CourseObject**](CourseObject.md) | | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # Clever::CoursesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**Array<CourseResponse>**](CourseResponse.md) | | [optional]
7
+ **links** | [**Array<Link>**](Link.md) | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # Clever::CoursesUpdated
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **created** | **String** | | [optional]
7
+ **id** | **String** | | [optional]
8
+ **type** | **String** | |
9
+ **data** | [**CourseObject**](CourseObject.md) | | [optional]
10
+ **previous_attributes** | **Object** | | [optional]
11
+
12
+
@@ -0,0 +1,8 @@
1
+ # Clever::Credentials
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **district_username** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,2852 @@
1
+ # Clever::DataApi
2
+
3
+ All URIs are relative to *https://api.clever.com/v2.1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} |
8
+ [**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts |
9
+ [**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
10
+ [**get_course**](DataApi.md#get_course) | **GET** /courses/{id} |
11
+ [**get_course_for_section**](DataApi.md#get_course_for_section) | **GET** /sections/{id}/course |
12
+ [**get_courses**](DataApi.md#get_courses) | **GET** /courses |
13
+ [**get_district**](DataApi.md#get_district) | **GET** /districts/{id} |
14
+ [**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
15
+ [**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins |
16
+ [**get_district_for_contact**](DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
17
+ [**get_district_for_course**](DataApi.md#get_district_for_course) | **GET** /courses/{id}/district |
18
+ [**get_district_for_district_admin**](DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
19
+ [**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
20
+ [**get_district_for_school_admin**](DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
21
+ [**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
22
+ [**get_district_for_student**](DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
23
+ [**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
24
+ [**get_district_for_term**](DataApi.md#get_district_for_term) | **GET** /terms/{id}/district |
25
+ [**get_districts**](DataApi.md#get_districts) | **GET** /districts |
26
+ [**get_school**](DataApi.md#get_school) | **GET** /schools/{id} |
27
+ [**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
28
+ [**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins |
29
+ [**get_school_for_section**](DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
30
+ [**get_school_for_student**](DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
31
+ [**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
32
+ [**get_schools**](DataApi.md#get_schools) | **GET** /schools |
33
+ [**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
34
+ [**get_schools_for_student**](DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
35
+ [**get_schools_for_teacher**](DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
36
+ [**get_section**](DataApi.md#get_section) | **GET** /sections/{id} |
37
+ [**get_sections**](DataApi.md#get_sections) | **GET** /sections |
38
+ [**get_sections_for_course**](DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
39
+ [**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
40
+ [**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
41
+ [**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
42
+ [**get_sections_for_term**](DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
43
+ [**get_student**](DataApi.md#get_student) | **GET** /students/{id} |
44
+ [**get_students**](DataApi.md#get_students) | **GET** /students |
45
+ [**get_students_for_contact**](DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
46
+ [**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
47
+ [**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
48
+ [**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
49
+ [**get_teacher**](DataApi.md#get_teacher) | **GET** /teachers/{id} |
50
+ [**get_teacher_for_section**](DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
51
+ [**get_teachers**](DataApi.md#get_teachers) | **GET** /teachers |
52
+ [**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
53
+ [**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
54
+ [**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
55
+ [**get_term**](DataApi.md#get_term) | **GET** /terms/{id} |
56
+ [**get_term_for_section**](DataApi.md#get_term_for_section) | **GET** /sections/{id}/term |
57
+ [**get_terms**](DataApi.md#get_terms) | **GET** /terms |
58
+
59
+
60
+ # **get_contact**
61
+ > ContactResponse get_contact(id)
62
+
63
+
64
+
65
+ Returns a specific student contact
66
+
67
+ ### Example
68
+ ```ruby
69
+ # load the gem
70
+ require 'clever-ruby'
71
+ # setup authorization
72
+ Clever.configure do |config|
73
+ # Configure OAuth2 access token for authorization: oauth
74
+ config.access_token = 'YOUR ACCESS TOKEN'
75
+ end
76
+
77
+ api_instance = Clever::DataApi.new
78
+
79
+ id = 'id_example' # String |
80
+
81
+
82
+ begin
83
+ result = api_instance.get_contact(id)
84
+ p result
85
+ rescue Clever::ApiError => e
86
+ puts "Exception when calling DataApi->get_contact: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ Name | Type | Description | Notes
93
+ ------------- | ------------- | ------------- | -------------
94
+ **id** | **String**| |
95
+
96
+ ### Return type
97
+
98
+ [**ContactResponse**](ContactResponse.md)
99
+
100
+ ### Authorization
101
+
102
+ [oauth](../README.md#oauth)
103
+
104
+ ### HTTP request headers
105
+
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: application/json
108
+
109
+
110
+
111
+ # **get_contacts**
112
+ > ContactsResponse get_contacts(opts)
113
+
114
+
115
+
116
+ Returns a list of student contacts
117
+
118
+ ### Example
119
+ ```ruby
120
+ # load the gem
121
+ require 'clever-ruby'
122
+ # setup authorization
123
+ Clever.configure do |config|
124
+ # Configure OAuth2 access token for authorization: oauth
125
+ config.access_token = 'YOUR ACCESS TOKEN'
126
+ end
127
+
128
+ api_instance = Clever::DataApi.new
129
+
130
+ opts = {
131
+ limit: 56, # Integer |
132
+ starting_after: 'starting_after_example', # String |
133
+ ending_before: 'ending_before_example', # String |
134
+ count: 'count_example' # String |
135
+ }
136
+
137
+ begin
138
+ result = api_instance.get_contacts(opts)
139
+ p result
140
+ rescue Clever::ApiError => e
141
+ puts "Exception when calling DataApi->get_contacts: #{e}"
142
+ end
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ Name | Type | Description | Notes
148
+ ------------- | ------------- | ------------- | -------------
149
+ **limit** | **Integer**| | [optional]
150
+ **starting_after** | **String**| | [optional]
151
+ **ending_before** | **String**| | [optional]
152
+ **count** | **String**| | [optional]
153
+
154
+ ### Return type
155
+
156
+ [**ContactsResponse**](ContactsResponse.md)
157
+
158
+ ### Authorization
159
+
160
+ [oauth](../README.md#oauth)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: Not defined
165
+ - **Accept**: application/json
166
+
167
+
168
+
169
+ # **get_contacts_for_student**
170
+ > ContactsResponse get_contacts_for_student(id, opts)
171
+
172
+
173
+
174
+ Returns the contacts for a student
175
+
176
+ ### Example
177
+ ```ruby
178
+ # load the gem
179
+ require 'clever-ruby'
180
+ # setup authorization
181
+ Clever.configure do |config|
182
+ # Configure OAuth2 access token for authorization: oauth
183
+ config.access_token = 'YOUR ACCESS TOKEN'
184
+ end
185
+
186
+ api_instance = Clever::DataApi.new
187
+
188
+ id = 'id_example' # String |
189
+
190
+ opts = {
191
+ limit: 56, # Integer |
192
+ starting_after: 'starting_after_example', # String |
193
+ ending_before: 'ending_before_example' # String |
194
+ }
195
+
196
+ begin
197
+ result = api_instance.get_contacts_for_student(id, opts)
198
+ p result
199
+ rescue Clever::ApiError => e
200
+ puts "Exception when calling DataApi->get_contacts_for_student: #{e}"
201
+ end
202
+ ```
203
+
204
+ ### Parameters
205
+
206
+ Name | Type | Description | Notes
207
+ ------------- | ------------- | ------------- | -------------
208
+ **id** | **String**| |
209
+ **limit** | **Integer**| | [optional]
210
+ **starting_after** | **String**| | [optional]
211
+ **ending_before** | **String**| | [optional]
212
+
213
+ ### Return type
214
+
215
+ [**ContactsResponse**](ContactsResponse.md)
216
+
217
+ ### Authorization
218
+
219
+ [oauth](../README.md#oauth)
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: Not defined
224
+ - **Accept**: application/json
225
+
226
+
227
+
228
+ # **get_course**
229
+ > CourseResponse get_course(id)
230
+
231
+
232
+
233
+ Returns a specific course
234
+
235
+ ### Example
236
+ ```ruby
237
+ # load the gem
238
+ require 'clever-ruby'
239
+ # setup authorization
240
+ Clever.configure do |config|
241
+ # Configure OAuth2 access token for authorization: oauth
242
+ config.access_token = 'YOUR ACCESS TOKEN'
243
+ end
244
+
245
+ api_instance = Clever::DataApi.new
246
+
247
+ id = 'id_example' # String |
248
+
249
+
250
+ begin
251
+ result = api_instance.get_course(id)
252
+ p result
253
+ rescue Clever::ApiError => e
254
+ puts "Exception when calling DataApi->get_course: #{e}"
255
+ end
256
+ ```
257
+
258
+ ### Parameters
259
+
260
+ Name | Type | Description | Notes
261
+ ------------- | ------------- | ------------- | -------------
262
+ **id** | **String**| |
263
+
264
+ ### Return type
265
+
266
+ [**CourseResponse**](CourseResponse.md)
267
+
268
+ ### Authorization
269
+
270
+ [oauth](../README.md#oauth)
271
+
272
+ ### HTTP request headers
273
+
274
+ - **Content-Type**: Not defined
275
+ - **Accept**: application/json
276
+
277
+
278
+
279
+ # **get_course_for_section**
280
+ > CourseResponse get_course_for_section(id)
281
+
282
+
283
+
284
+ Returns the course for a section
285
+
286
+ ### Example
287
+ ```ruby
288
+ # load the gem
289
+ require 'clever-ruby'
290
+ # setup authorization
291
+ Clever.configure do |config|
292
+ # Configure OAuth2 access token for authorization: oauth
293
+ config.access_token = 'YOUR ACCESS TOKEN'
294
+ end
295
+
296
+ api_instance = Clever::DataApi.new
297
+
298
+ id = 'id_example' # String |
299
+
300
+
301
+ begin
302
+ result = api_instance.get_course_for_section(id)
303
+ p result
304
+ rescue Clever::ApiError => e
305
+ puts "Exception when calling DataApi->get_course_for_section: #{e}"
306
+ end
307
+ ```
308
+
309
+ ### Parameters
310
+
311
+ Name | Type | Description | Notes
312
+ ------------- | ------------- | ------------- | -------------
313
+ **id** | **String**| |
314
+
315
+ ### Return type
316
+
317
+ [**CourseResponse**](CourseResponse.md)
318
+
319
+ ### Authorization
320
+
321
+ [oauth](../README.md#oauth)
322
+
323
+ ### HTTP request headers
324
+
325
+ - **Content-Type**: Not defined
326
+ - **Accept**: application/json
327
+
328
+
329
+
330
+ # **get_courses**
331
+ > CoursesResponse get_courses(opts)
332
+
333
+
334
+
335
+ Returns a list of courses
336
+
337
+ ### Example
338
+ ```ruby
339
+ # load the gem
340
+ require 'clever-ruby'
341
+ # setup authorization
342
+ Clever.configure do |config|
343
+ # Configure OAuth2 access token for authorization: oauth
344
+ config.access_token = 'YOUR ACCESS TOKEN'
345
+ end
346
+
347
+ api_instance = Clever::DataApi.new
348
+
349
+ opts = {
350
+ limit: 56, # Integer |
351
+ starting_after: 'starting_after_example', # String |
352
+ ending_before: 'ending_before_example', # String |
353
+ count: 'count_example' # String |
354
+ }
355
+
356
+ begin
357
+ result = api_instance.get_courses(opts)
358
+ p result
359
+ rescue Clever::ApiError => e
360
+ puts "Exception when calling DataApi->get_courses: #{e}"
361
+ end
362
+ ```
363
+
364
+ ### Parameters
365
+
366
+ Name | Type | Description | Notes
367
+ ------------- | ------------- | ------------- | -------------
368
+ **limit** | **Integer**| | [optional]
369
+ **starting_after** | **String**| | [optional]
370
+ **ending_before** | **String**| | [optional]
371
+ **count** | **String**| | [optional]
372
+
373
+ ### Return type
374
+
375
+ [**CoursesResponse**](CoursesResponse.md)
376
+
377
+ ### Authorization
378
+
379
+ [oauth](../README.md#oauth)
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: Not defined
384
+ - **Accept**: application/json
385
+
386
+
387
+
388
+ # **get_district**
389
+ > DistrictResponse get_district(id)
390
+
391
+
392
+
393
+ Returns a specific district
394
+
395
+ ### Example
396
+ ```ruby
397
+ # load the gem
398
+ require 'clever-ruby'
399
+ # setup authorization
400
+ Clever.configure do |config|
401
+ # Configure OAuth2 access token for authorization: oauth
402
+ config.access_token = 'YOUR ACCESS TOKEN'
403
+ end
404
+
405
+ api_instance = Clever::DataApi.new
406
+
407
+ id = 'id_example' # String |
408
+
409
+
410
+ begin
411
+ result = api_instance.get_district(id)
412
+ p result
413
+ rescue Clever::ApiError => e
414
+ puts "Exception when calling DataApi->get_district: #{e}"
415
+ end
416
+ ```
417
+
418
+ ### Parameters
419
+
420
+ Name | Type | Description | Notes
421
+ ------------- | ------------- | ------------- | -------------
422
+ **id** | **String**| |
423
+
424
+ ### Return type
425
+
426
+ [**DistrictResponse**](DistrictResponse.md)
427
+
428
+ ### Authorization
429
+
430
+ [oauth](../README.md#oauth)
431
+
432
+ ### HTTP request headers
433
+
434
+ - **Content-Type**: Not defined
435
+ - **Accept**: application/json
436
+
437
+
438
+
439
+ # **get_district_admin**
440
+ > DistrictAdminResponse get_district_admin(id)
441
+
442
+
443
+
444
+ Returns a specific district admin
445
+
446
+ ### Example
447
+ ```ruby
448
+ # load the gem
449
+ require 'clever-ruby'
450
+ # setup authorization
451
+ Clever.configure do |config|
452
+ # Configure OAuth2 access token for authorization: oauth
453
+ config.access_token = 'YOUR ACCESS TOKEN'
454
+ end
455
+
456
+ api_instance = Clever::DataApi.new
457
+
458
+ id = 'id_example' # String |
459
+
460
+
461
+ begin
462
+ result = api_instance.get_district_admin(id)
463
+ p result
464
+ rescue Clever::ApiError => e
465
+ puts "Exception when calling DataApi->get_district_admin: #{e}"
466
+ end
467
+ ```
468
+
469
+ ### Parameters
470
+
471
+ Name | Type | Description | Notes
472
+ ------------- | ------------- | ------------- | -------------
473
+ **id** | **String**| |
474
+
475
+ ### Return type
476
+
477
+ [**DistrictAdminResponse**](DistrictAdminResponse.md)
478
+
479
+ ### Authorization
480
+
481
+ [oauth](../README.md#oauth)
482
+
483
+ ### HTTP request headers
484
+
485
+ - **Content-Type**: Not defined
486
+ - **Accept**: application/json
487
+
488
+
489
+
490
+ # **get_district_admins**
491
+ > DistrictAdminsResponse get_district_admins(opts)
492
+
493
+
494
+
495
+ Returns a list of district admins
496
+
497
+ ### Example
498
+ ```ruby
499
+ # load the gem
500
+ require 'clever-ruby'
501
+ # setup authorization
502
+ Clever.configure do |config|
503
+ # Configure OAuth2 access token for authorization: oauth
504
+ config.access_token = 'YOUR ACCESS TOKEN'
505
+ end
506
+
507
+ api_instance = Clever::DataApi.new
508
+
509
+ opts = {
510
+ limit: 56, # Integer |
511
+ starting_after: 'starting_after_example', # String |
512
+ ending_before: 'ending_before_example', # String |
513
+ count: 'count_example' # String |
514
+ }
515
+
516
+ begin
517
+ result = api_instance.get_district_admins(opts)
518
+ p result
519
+ rescue Clever::ApiError => e
520
+ puts "Exception when calling DataApi->get_district_admins: #{e}"
521
+ end
522
+ ```
523
+
524
+ ### Parameters
525
+
526
+ Name | Type | Description | Notes
527
+ ------------- | ------------- | ------------- | -------------
528
+ **limit** | **Integer**| | [optional]
529
+ **starting_after** | **String**| | [optional]
530
+ **ending_before** | **String**| | [optional]
531
+ **count** | **String**| | [optional]
532
+
533
+ ### Return type
534
+
535
+ [**DistrictAdminsResponse**](DistrictAdminsResponse.md)
536
+
537
+ ### Authorization
538
+
539
+ [oauth](../README.md#oauth)
540
+
541
+ ### HTTP request headers
542
+
543
+ - **Content-Type**: Not defined
544
+ - **Accept**: application/json
545
+
546
+
547
+
548
+ # **get_district_for_contact**
549
+ > DistrictResponse get_district_for_contact(id)
550
+
551
+
552
+
553
+ Returns the district for a student contact
554
+
555
+ ### Example
556
+ ```ruby
557
+ # load the gem
558
+ require 'clever-ruby'
559
+ # setup authorization
560
+ Clever.configure do |config|
561
+ # Configure OAuth2 access token for authorization: oauth
562
+ config.access_token = 'YOUR ACCESS TOKEN'
563
+ end
564
+
565
+ api_instance = Clever::DataApi.new
566
+
567
+ id = 'id_example' # String |
568
+
569
+
570
+ begin
571
+ result = api_instance.get_district_for_contact(id)
572
+ p result
573
+ rescue Clever::ApiError => e
574
+ puts "Exception when calling DataApi->get_district_for_contact: #{e}"
575
+ end
576
+ ```
577
+
578
+ ### Parameters
579
+
580
+ Name | Type | Description | Notes
581
+ ------------- | ------------- | ------------- | -------------
582
+ **id** | **String**| |
583
+
584
+ ### Return type
585
+
586
+ [**DistrictResponse**](DistrictResponse.md)
587
+
588
+ ### Authorization
589
+
590
+ [oauth](../README.md#oauth)
591
+
592
+ ### HTTP request headers
593
+
594
+ - **Content-Type**: Not defined
595
+ - **Accept**: application/json
596
+
597
+
598
+
599
+ # **get_district_for_course**
600
+ > DistrictResponse get_district_for_course(id)
601
+
602
+
603
+
604
+ Returns the district for a course
605
+
606
+ ### Example
607
+ ```ruby
608
+ # load the gem
609
+ require 'clever-ruby'
610
+ # setup authorization
611
+ Clever.configure do |config|
612
+ # Configure OAuth2 access token for authorization: oauth
613
+ config.access_token = 'YOUR ACCESS TOKEN'
614
+ end
615
+
616
+ api_instance = Clever::DataApi.new
617
+
618
+ id = 'id_example' # String |
619
+
620
+
621
+ begin
622
+ result = api_instance.get_district_for_course(id)
623
+ p result
624
+ rescue Clever::ApiError => e
625
+ puts "Exception when calling DataApi->get_district_for_course: #{e}"
626
+ end
627
+ ```
628
+
629
+ ### Parameters
630
+
631
+ Name | Type | Description | Notes
632
+ ------------- | ------------- | ------------- | -------------
633
+ **id** | **String**| |
634
+
635
+ ### Return type
636
+
637
+ [**DistrictResponse**](DistrictResponse.md)
638
+
639
+ ### Authorization
640
+
641
+ [oauth](../README.md#oauth)
642
+
643
+ ### HTTP request headers
644
+
645
+ - **Content-Type**: Not defined
646
+ - **Accept**: application/json
647
+
648
+
649
+
650
+ # **get_district_for_district_admin**
651
+ > DistrictResponse get_district_for_district_admin(id)
652
+
653
+
654
+
655
+ Returns the district for a district admin
656
+
657
+ ### Example
658
+ ```ruby
659
+ # load the gem
660
+ require 'clever-ruby'
661
+ # setup authorization
662
+ Clever.configure do |config|
663
+ # Configure OAuth2 access token for authorization: oauth
664
+ config.access_token = 'YOUR ACCESS TOKEN'
665
+ end
666
+
667
+ api_instance = Clever::DataApi.new
668
+
669
+ id = 'id_example' # String |
670
+
671
+
672
+ begin
673
+ result = api_instance.get_district_for_district_admin(id)
674
+ p result
675
+ rescue Clever::ApiError => e
676
+ puts "Exception when calling DataApi->get_district_for_district_admin: #{e}"
677
+ end
678
+ ```
679
+
680
+ ### Parameters
681
+
682
+ Name | Type | Description | Notes
683
+ ------------- | ------------- | ------------- | -------------
684
+ **id** | **String**| |
685
+
686
+ ### Return type
687
+
688
+ [**DistrictResponse**](DistrictResponse.md)
689
+
690
+ ### Authorization
691
+
692
+ [oauth](../README.md#oauth)
693
+
694
+ ### HTTP request headers
695
+
696
+ - **Content-Type**: Not defined
697
+ - **Accept**: application/json
698
+
699
+
700
+
701
+ # **get_district_for_school**
702
+ > DistrictResponse get_district_for_school(id)
703
+
704
+
705
+
706
+ Returns the district for a school
707
+
708
+ ### Example
709
+ ```ruby
710
+ # load the gem
711
+ require 'clever-ruby'
712
+ # setup authorization
713
+ Clever.configure do |config|
714
+ # Configure OAuth2 access token for authorization: oauth
715
+ config.access_token = 'YOUR ACCESS TOKEN'
716
+ end
717
+
718
+ api_instance = Clever::DataApi.new
719
+
720
+ id = 'id_example' # String |
721
+
722
+
723
+ begin
724
+ result = api_instance.get_district_for_school(id)
725
+ p result
726
+ rescue Clever::ApiError => e
727
+ puts "Exception when calling DataApi->get_district_for_school: #{e}"
728
+ end
729
+ ```
730
+
731
+ ### Parameters
732
+
733
+ Name | Type | Description | Notes
734
+ ------------- | ------------- | ------------- | -------------
735
+ **id** | **String**| |
736
+
737
+ ### Return type
738
+
739
+ [**DistrictResponse**](DistrictResponse.md)
740
+
741
+ ### Authorization
742
+
743
+ [oauth](../README.md#oauth)
744
+
745
+ ### HTTP request headers
746
+
747
+ - **Content-Type**: Not defined
748
+ - **Accept**: application/json
749
+
750
+
751
+
752
+ # **get_district_for_school_admin**
753
+ > DistrictResponse get_district_for_school_admin(id)
754
+
755
+
756
+
757
+ Returns the district for a school admin
758
+
759
+ ### Example
760
+ ```ruby
761
+ # load the gem
762
+ require 'clever-ruby'
763
+ # setup authorization
764
+ Clever.configure do |config|
765
+ # Configure OAuth2 access token for authorization: oauth
766
+ config.access_token = 'YOUR ACCESS TOKEN'
767
+ end
768
+
769
+ api_instance = Clever::DataApi.new
770
+
771
+ id = 'id_example' # String |
772
+
773
+
774
+ begin
775
+ result = api_instance.get_district_for_school_admin(id)
776
+ p result
777
+ rescue Clever::ApiError => e
778
+ puts "Exception when calling DataApi->get_district_for_school_admin: #{e}"
779
+ end
780
+ ```
781
+
782
+ ### Parameters
783
+
784
+ Name | Type | Description | Notes
785
+ ------------- | ------------- | ------------- | -------------
786
+ **id** | **String**| |
787
+
788
+ ### Return type
789
+
790
+ [**DistrictResponse**](DistrictResponse.md)
791
+
792
+ ### Authorization
793
+
794
+ [oauth](../README.md#oauth)
795
+
796
+ ### HTTP request headers
797
+
798
+ - **Content-Type**: Not defined
799
+ - **Accept**: application/json
800
+
801
+
802
+
803
+ # **get_district_for_section**
804
+ > DistrictResponse get_district_for_section(id)
805
+
806
+
807
+
808
+ Returns the district for a section
809
+
810
+ ### Example
811
+ ```ruby
812
+ # load the gem
813
+ require 'clever-ruby'
814
+ # setup authorization
815
+ Clever.configure do |config|
816
+ # Configure OAuth2 access token for authorization: oauth
817
+ config.access_token = 'YOUR ACCESS TOKEN'
818
+ end
819
+
820
+ api_instance = Clever::DataApi.new
821
+
822
+ id = 'id_example' # String |
823
+
824
+
825
+ begin
826
+ result = api_instance.get_district_for_section(id)
827
+ p result
828
+ rescue Clever::ApiError => e
829
+ puts "Exception when calling DataApi->get_district_for_section: #{e}"
830
+ end
831
+ ```
832
+
833
+ ### Parameters
834
+
835
+ Name | Type | Description | Notes
836
+ ------------- | ------------- | ------------- | -------------
837
+ **id** | **String**| |
838
+
839
+ ### Return type
840
+
841
+ [**DistrictResponse**](DistrictResponse.md)
842
+
843
+ ### Authorization
844
+
845
+ [oauth](../README.md#oauth)
846
+
847
+ ### HTTP request headers
848
+
849
+ - **Content-Type**: Not defined
850
+ - **Accept**: application/json
851
+
852
+
853
+
854
+ # **get_district_for_student**
855
+ > DistrictResponse get_district_for_student(id)
856
+
857
+
858
+
859
+ Returns the district for a student
860
+
861
+ ### Example
862
+ ```ruby
863
+ # load the gem
864
+ require 'clever-ruby'
865
+ # setup authorization
866
+ Clever.configure do |config|
867
+ # Configure OAuth2 access token for authorization: oauth
868
+ config.access_token = 'YOUR ACCESS TOKEN'
869
+ end
870
+
871
+ api_instance = Clever::DataApi.new
872
+
873
+ id = 'id_example' # String |
874
+
875
+
876
+ begin
877
+ result = api_instance.get_district_for_student(id)
878
+ p result
879
+ rescue Clever::ApiError => e
880
+ puts "Exception when calling DataApi->get_district_for_student: #{e}"
881
+ end
882
+ ```
883
+
884
+ ### Parameters
885
+
886
+ Name | Type | Description | Notes
887
+ ------------- | ------------- | ------------- | -------------
888
+ **id** | **String**| |
889
+
890
+ ### Return type
891
+
892
+ [**DistrictResponse**](DistrictResponse.md)
893
+
894
+ ### Authorization
895
+
896
+ [oauth](../README.md#oauth)
897
+
898
+ ### HTTP request headers
899
+
900
+ - **Content-Type**: Not defined
901
+ - **Accept**: application/json
902
+
903
+
904
+
905
+ # **get_district_for_teacher**
906
+ > DistrictResponse get_district_for_teacher(id)
907
+
908
+
909
+
910
+ Returns the district for a teacher
911
+
912
+ ### Example
913
+ ```ruby
914
+ # load the gem
915
+ require 'clever-ruby'
916
+ # setup authorization
917
+ Clever.configure do |config|
918
+ # Configure OAuth2 access token for authorization: oauth
919
+ config.access_token = 'YOUR ACCESS TOKEN'
920
+ end
921
+
922
+ api_instance = Clever::DataApi.new
923
+
924
+ id = 'id_example' # String |
925
+
926
+
927
+ begin
928
+ result = api_instance.get_district_for_teacher(id)
929
+ p result
930
+ rescue Clever::ApiError => e
931
+ puts "Exception when calling DataApi->get_district_for_teacher: #{e}"
932
+ end
933
+ ```
934
+
935
+ ### Parameters
936
+
937
+ Name | Type | Description | Notes
938
+ ------------- | ------------- | ------------- | -------------
939
+ **id** | **String**| |
940
+
941
+ ### Return type
942
+
943
+ [**DistrictResponse**](DistrictResponse.md)
944
+
945
+ ### Authorization
946
+
947
+ [oauth](../README.md#oauth)
948
+
949
+ ### HTTP request headers
950
+
951
+ - **Content-Type**: Not defined
952
+ - **Accept**: application/json
953
+
954
+
955
+
956
+ # **get_district_for_term**
957
+ > DistrictResponse get_district_for_term(id)
958
+
959
+
960
+
961
+ Returns the district for a term
962
+
963
+ ### Example
964
+ ```ruby
965
+ # load the gem
966
+ require 'clever-ruby'
967
+ # setup authorization
968
+ Clever.configure do |config|
969
+ # Configure OAuth2 access token for authorization: oauth
970
+ config.access_token = 'YOUR ACCESS TOKEN'
971
+ end
972
+
973
+ api_instance = Clever::DataApi.new
974
+
975
+ id = 'id_example' # String |
976
+
977
+
978
+ begin
979
+ result = api_instance.get_district_for_term(id)
980
+ p result
981
+ rescue Clever::ApiError => e
982
+ puts "Exception when calling DataApi->get_district_for_term: #{e}"
983
+ end
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ Name | Type | Description | Notes
989
+ ------------- | ------------- | ------------- | -------------
990
+ **id** | **String**| |
991
+
992
+ ### Return type
993
+
994
+ [**DistrictResponse**](DistrictResponse.md)
995
+
996
+ ### Authorization
997
+
998
+ [oauth](../README.md#oauth)
999
+
1000
+ ### HTTP request headers
1001
+
1002
+ - **Content-Type**: Not defined
1003
+ - **Accept**: application/json
1004
+
1005
+
1006
+
1007
+ # **get_districts**
1008
+ > DistrictsResponse get_districts(opts)
1009
+
1010
+
1011
+
1012
+ Returns a list of districts
1013
+
1014
+ ### Example
1015
+ ```ruby
1016
+ # load the gem
1017
+ require 'clever-ruby'
1018
+ # setup authorization
1019
+ Clever.configure do |config|
1020
+ # Configure OAuth2 access token for authorization: oauth
1021
+ config.access_token = 'YOUR ACCESS TOKEN'
1022
+ end
1023
+
1024
+ api_instance = Clever::DataApi.new
1025
+
1026
+ opts = {
1027
+ count: 'count_example' # String |
1028
+ }
1029
+
1030
+ begin
1031
+ result = api_instance.get_districts(opts)
1032
+ p result
1033
+ rescue Clever::ApiError => e
1034
+ puts "Exception when calling DataApi->get_districts: #{e}"
1035
+ end
1036
+ ```
1037
+
1038
+ ### Parameters
1039
+
1040
+ Name | Type | Description | Notes
1041
+ ------------- | ------------- | ------------- | -------------
1042
+ **count** | **String**| | [optional]
1043
+
1044
+ ### Return type
1045
+
1046
+ [**DistrictsResponse**](DistrictsResponse.md)
1047
+
1048
+ ### Authorization
1049
+
1050
+ [oauth](../README.md#oauth)
1051
+
1052
+ ### HTTP request headers
1053
+
1054
+ - **Content-Type**: Not defined
1055
+ - **Accept**: application/json
1056
+
1057
+
1058
+
1059
+ # **get_school**
1060
+ > SchoolResponse get_school(id)
1061
+
1062
+
1063
+
1064
+ Returns a specific school
1065
+
1066
+ ### Example
1067
+ ```ruby
1068
+ # load the gem
1069
+ require 'clever-ruby'
1070
+ # setup authorization
1071
+ Clever.configure do |config|
1072
+ # Configure OAuth2 access token for authorization: oauth
1073
+ config.access_token = 'YOUR ACCESS TOKEN'
1074
+ end
1075
+
1076
+ api_instance = Clever::DataApi.new
1077
+
1078
+ id = 'id_example' # String |
1079
+
1080
+
1081
+ begin
1082
+ result = api_instance.get_school(id)
1083
+ p result
1084
+ rescue Clever::ApiError => e
1085
+ puts "Exception when calling DataApi->get_school: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+
1091
+ Name | Type | Description | Notes
1092
+ ------------- | ------------- | ------------- | -------------
1093
+ **id** | **String**| |
1094
+
1095
+ ### Return type
1096
+
1097
+ [**SchoolResponse**](SchoolResponse.md)
1098
+
1099
+ ### Authorization
1100
+
1101
+ [oauth](../README.md#oauth)
1102
+
1103
+ ### HTTP request headers
1104
+
1105
+ - **Content-Type**: Not defined
1106
+ - **Accept**: application/json
1107
+
1108
+
1109
+
1110
+ # **get_school_admin**
1111
+ > SchoolAdminResponse get_school_admin(id)
1112
+
1113
+
1114
+
1115
+ Returns a specific school admin
1116
+
1117
+ ### Example
1118
+ ```ruby
1119
+ # load the gem
1120
+ require 'clever-ruby'
1121
+ # setup authorization
1122
+ Clever.configure do |config|
1123
+ # Configure OAuth2 access token for authorization: oauth
1124
+ config.access_token = 'YOUR ACCESS TOKEN'
1125
+ end
1126
+
1127
+ api_instance = Clever::DataApi.new
1128
+
1129
+ id = 'id_example' # String |
1130
+
1131
+
1132
+ begin
1133
+ result = api_instance.get_school_admin(id)
1134
+ p result
1135
+ rescue Clever::ApiError => e
1136
+ puts "Exception when calling DataApi->get_school_admin: #{e}"
1137
+ end
1138
+ ```
1139
+
1140
+ ### Parameters
1141
+
1142
+ Name | Type | Description | Notes
1143
+ ------------- | ------------- | ------------- | -------------
1144
+ **id** | **String**| |
1145
+
1146
+ ### Return type
1147
+
1148
+ [**SchoolAdminResponse**](SchoolAdminResponse.md)
1149
+
1150
+ ### Authorization
1151
+
1152
+ [oauth](../README.md#oauth)
1153
+
1154
+ ### HTTP request headers
1155
+
1156
+ - **Content-Type**: Not defined
1157
+ - **Accept**: application/json
1158
+
1159
+
1160
+
1161
+ # **get_school_admins**
1162
+ > SchoolAdminsResponse get_school_admins(opts)
1163
+
1164
+
1165
+
1166
+ Returns a list of school admins
1167
+
1168
+ ### Example
1169
+ ```ruby
1170
+ # load the gem
1171
+ require 'clever-ruby'
1172
+ # setup authorization
1173
+ Clever.configure do |config|
1174
+ # Configure OAuth2 access token for authorization: oauth
1175
+ config.access_token = 'YOUR ACCESS TOKEN'
1176
+ end
1177
+
1178
+ api_instance = Clever::DataApi.new
1179
+
1180
+ opts = {
1181
+ limit: 56, # Integer |
1182
+ starting_after: 'starting_after_example', # String |
1183
+ ending_before: 'ending_before_example', # String |
1184
+ count: 'count_example' # String |
1185
+ }
1186
+
1187
+ begin
1188
+ result = api_instance.get_school_admins(opts)
1189
+ p result
1190
+ rescue Clever::ApiError => e
1191
+ puts "Exception when calling DataApi->get_school_admins: #{e}"
1192
+ end
1193
+ ```
1194
+
1195
+ ### Parameters
1196
+
1197
+ Name | Type | Description | Notes
1198
+ ------------- | ------------- | ------------- | -------------
1199
+ **limit** | **Integer**| | [optional]
1200
+ **starting_after** | **String**| | [optional]
1201
+ **ending_before** | **String**| | [optional]
1202
+ **count** | **String**| | [optional]
1203
+
1204
+ ### Return type
1205
+
1206
+ [**SchoolAdminsResponse**](SchoolAdminsResponse.md)
1207
+
1208
+ ### Authorization
1209
+
1210
+ [oauth](../README.md#oauth)
1211
+
1212
+ ### HTTP request headers
1213
+
1214
+ - **Content-Type**: Not defined
1215
+ - **Accept**: application/json
1216
+
1217
+
1218
+
1219
+ # **get_school_for_section**
1220
+ > SchoolResponse get_school_for_section(id)
1221
+
1222
+
1223
+
1224
+ Returns the school for a section
1225
+
1226
+ ### Example
1227
+ ```ruby
1228
+ # load the gem
1229
+ require 'clever-ruby'
1230
+ # setup authorization
1231
+ Clever.configure do |config|
1232
+ # Configure OAuth2 access token for authorization: oauth
1233
+ config.access_token = 'YOUR ACCESS TOKEN'
1234
+ end
1235
+
1236
+ api_instance = Clever::DataApi.new
1237
+
1238
+ id = 'id_example' # String |
1239
+
1240
+
1241
+ begin
1242
+ result = api_instance.get_school_for_section(id)
1243
+ p result
1244
+ rescue Clever::ApiError => e
1245
+ puts "Exception when calling DataApi->get_school_for_section: #{e}"
1246
+ end
1247
+ ```
1248
+
1249
+ ### Parameters
1250
+
1251
+ Name | Type | Description | Notes
1252
+ ------------- | ------------- | ------------- | -------------
1253
+ **id** | **String**| |
1254
+
1255
+ ### Return type
1256
+
1257
+ [**SchoolResponse**](SchoolResponse.md)
1258
+
1259
+ ### Authorization
1260
+
1261
+ [oauth](../README.md#oauth)
1262
+
1263
+ ### HTTP request headers
1264
+
1265
+ - **Content-Type**: Not defined
1266
+ - **Accept**: application/json
1267
+
1268
+
1269
+
1270
+ # **get_school_for_student**
1271
+ > SchoolResponse get_school_for_student(id)
1272
+
1273
+
1274
+
1275
+ Returns the primary school for a student
1276
+
1277
+ ### Example
1278
+ ```ruby
1279
+ # load the gem
1280
+ require 'clever-ruby'
1281
+ # setup authorization
1282
+ Clever.configure do |config|
1283
+ # Configure OAuth2 access token for authorization: oauth
1284
+ config.access_token = 'YOUR ACCESS TOKEN'
1285
+ end
1286
+
1287
+ api_instance = Clever::DataApi.new
1288
+
1289
+ id = 'id_example' # String |
1290
+
1291
+
1292
+ begin
1293
+ result = api_instance.get_school_for_student(id)
1294
+ p result
1295
+ rescue Clever::ApiError => e
1296
+ puts "Exception when calling DataApi->get_school_for_student: #{e}"
1297
+ end
1298
+ ```
1299
+
1300
+ ### Parameters
1301
+
1302
+ Name | Type | Description | Notes
1303
+ ------------- | ------------- | ------------- | -------------
1304
+ **id** | **String**| |
1305
+
1306
+ ### Return type
1307
+
1308
+ [**SchoolResponse**](SchoolResponse.md)
1309
+
1310
+ ### Authorization
1311
+
1312
+ [oauth](../README.md#oauth)
1313
+
1314
+ ### HTTP request headers
1315
+
1316
+ - **Content-Type**: Not defined
1317
+ - **Accept**: application/json
1318
+
1319
+
1320
+
1321
+ # **get_school_for_teacher**
1322
+ > SchoolResponse get_school_for_teacher(id)
1323
+
1324
+
1325
+
1326
+ Retrieves school info for a teacher.
1327
+
1328
+ ### Example
1329
+ ```ruby
1330
+ # load the gem
1331
+ require 'clever-ruby'
1332
+ # setup authorization
1333
+ Clever.configure do |config|
1334
+ # Configure OAuth2 access token for authorization: oauth
1335
+ config.access_token = 'YOUR ACCESS TOKEN'
1336
+ end
1337
+
1338
+ api_instance = Clever::DataApi.new
1339
+
1340
+ id = 'id_example' # String |
1341
+
1342
+
1343
+ begin
1344
+ result = api_instance.get_school_for_teacher(id)
1345
+ p result
1346
+ rescue Clever::ApiError => e
1347
+ puts "Exception when calling DataApi->get_school_for_teacher: #{e}"
1348
+ end
1349
+ ```
1350
+
1351
+ ### Parameters
1352
+
1353
+ Name | Type | Description | Notes
1354
+ ------------- | ------------- | ------------- | -------------
1355
+ **id** | **String**| |
1356
+
1357
+ ### Return type
1358
+
1359
+ [**SchoolResponse**](SchoolResponse.md)
1360
+
1361
+ ### Authorization
1362
+
1363
+ [oauth](../README.md#oauth)
1364
+
1365
+ ### HTTP request headers
1366
+
1367
+ - **Content-Type**: Not defined
1368
+ - **Accept**: application/json
1369
+
1370
+
1371
+
1372
+ # **get_schools**
1373
+ > SchoolsResponse get_schools(opts)
1374
+
1375
+
1376
+
1377
+ Returns a list of schools
1378
+
1379
+ ### Example
1380
+ ```ruby
1381
+ # load the gem
1382
+ require 'clever-ruby'
1383
+ # setup authorization
1384
+ Clever.configure do |config|
1385
+ # Configure OAuth2 access token for authorization: oauth
1386
+ config.access_token = 'YOUR ACCESS TOKEN'
1387
+ end
1388
+
1389
+ api_instance = Clever::DataApi.new
1390
+
1391
+ opts = {
1392
+ limit: 56, # Integer |
1393
+ starting_after: 'starting_after_example', # String |
1394
+ ending_before: 'ending_before_example', # String |
1395
+ count: 'count_example' # String |
1396
+ }
1397
+
1398
+ begin
1399
+ result = api_instance.get_schools(opts)
1400
+ p result
1401
+ rescue Clever::ApiError => e
1402
+ puts "Exception when calling DataApi->get_schools: #{e}"
1403
+ end
1404
+ ```
1405
+
1406
+ ### Parameters
1407
+
1408
+ Name | Type | Description | Notes
1409
+ ------------- | ------------- | ------------- | -------------
1410
+ **limit** | **Integer**| | [optional]
1411
+ **starting_after** | **String**| | [optional]
1412
+ **ending_before** | **String**| | [optional]
1413
+ **count** | **String**| | [optional]
1414
+
1415
+ ### Return type
1416
+
1417
+ [**SchoolsResponse**](SchoolsResponse.md)
1418
+
1419
+ ### Authorization
1420
+
1421
+ [oauth](../README.md#oauth)
1422
+
1423
+ ### HTTP request headers
1424
+
1425
+ - **Content-Type**: Not defined
1426
+ - **Accept**: application/json
1427
+
1428
+
1429
+
1430
+ # **get_schools_for_school_admin**
1431
+ > SchoolsResponse get_schools_for_school_admin(id, opts)
1432
+
1433
+
1434
+
1435
+ Returns the schools for a school admin
1436
+
1437
+ ### Example
1438
+ ```ruby
1439
+ # load the gem
1440
+ require 'clever-ruby'
1441
+ # setup authorization
1442
+ Clever.configure do |config|
1443
+ # Configure OAuth2 access token for authorization: oauth
1444
+ config.access_token = 'YOUR ACCESS TOKEN'
1445
+ end
1446
+
1447
+ api_instance = Clever::DataApi.new
1448
+
1449
+ id = 'id_example' # String |
1450
+
1451
+ opts = {
1452
+ limit: 56, # Integer |
1453
+ starting_after: 'starting_after_example', # String |
1454
+ ending_before: 'ending_before_example' # String |
1455
+ }
1456
+
1457
+ begin
1458
+ result = api_instance.get_schools_for_school_admin(id, opts)
1459
+ p result
1460
+ rescue Clever::ApiError => e
1461
+ puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}"
1462
+ end
1463
+ ```
1464
+
1465
+ ### Parameters
1466
+
1467
+ Name | Type | Description | Notes
1468
+ ------------- | ------------- | ------------- | -------------
1469
+ **id** | **String**| |
1470
+ **limit** | **Integer**| | [optional]
1471
+ **starting_after** | **String**| | [optional]
1472
+ **ending_before** | **String**| | [optional]
1473
+
1474
+ ### Return type
1475
+
1476
+ [**SchoolsResponse**](SchoolsResponse.md)
1477
+
1478
+ ### Authorization
1479
+
1480
+ [oauth](../README.md#oauth)
1481
+
1482
+ ### HTTP request headers
1483
+
1484
+ - **Content-Type**: Not defined
1485
+ - **Accept**: application/json
1486
+
1487
+
1488
+
1489
+ # **get_schools_for_student**
1490
+ > SchoolsResponse get_schools_for_student(id, opts)
1491
+
1492
+
1493
+
1494
+ Returns the schools for a student
1495
+
1496
+ ### Example
1497
+ ```ruby
1498
+ # load the gem
1499
+ require 'clever-ruby'
1500
+ # setup authorization
1501
+ Clever.configure do |config|
1502
+ # Configure OAuth2 access token for authorization: oauth
1503
+ config.access_token = 'YOUR ACCESS TOKEN'
1504
+ end
1505
+
1506
+ api_instance = Clever::DataApi.new
1507
+
1508
+ id = 'id_example' # String |
1509
+
1510
+ opts = {
1511
+ limit: 56, # Integer |
1512
+ starting_after: 'starting_after_example', # String |
1513
+ ending_before: 'ending_before_example' # String |
1514
+ }
1515
+
1516
+ begin
1517
+ result = api_instance.get_schools_for_student(id, opts)
1518
+ p result
1519
+ rescue Clever::ApiError => e
1520
+ puts "Exception when calling DataApi->get_schools_for_student: #{e}"
1521
+ end
1522
+ ```
1523
+
1524
+ ### Parameters
1525
+
1526
+ Name | Type | Description | Notes
1527
+ ------------- | ------------- | ------------- | -------------
1528
+ **id** | **String**| |
1529
+ **limit** | **Integer**| | [optional]
1530
+ **starting_after** | **String**| | [optional]
1531
+ **ending_before** | **String**| | [optional]
1532
+
1533
+ ### Return type
1534
+
1535
+ [**SchoolsResponse**](SchoolsResponse.md)
1536
+
1537
+ ### Authorization
1538
+
1539
+ [oauth](../README.md#oauth)
1540
+
1541
+ ### HTTP request headers
1542
+
1543
+ - **Content-Type**: Not defined
1544
+ - **Accept**: application/json
1545
+
1546
+
1547
+
1548
+ # **get_schools_for_teacher**
1549
+ > SchoolsResponse get_schools_for_teacher(id, opts)
1550
+
1551
+
1552
+
1553
+ Returns the schools for a teacher
1554
+
1555
+ ### Example
1556
+ ```ruby
1557
+ # load the gem
1558
+ require 'clever-ruby'
1559
+ # setup authorization
1560
+ Clever.configure do |config|
1561
+ # Configure OAuth2 access token for authorization: oauth
1562
+ config.access_token = 'YOUR ACCESS TOKEN'
1563
+ end
1564
+
1565
+ api_instance = Clever::DataApi.new
1566
+
1567
+ id = 'id_example' # String |
1568
+
1569
+ opts = {
1570
+ limit: 56, # Integer |
1571
+ starting_after: 'starting_after_example', # String |
1572
+ ending_before: 'ending_before_example' # String |
1573
+ }
1574
+
1575
+ begin
1576
+ result = api_instance.get_schools_for_teacher(id, opts)
1577
+ p result
1578
+ rescue Clever::ApiError => e
1579
+ puts "Exception when calling DataApi->get_schools_for_teacher: #{e}"
1580
+ end
1581
+ ```
1582
+
1583
+ ### Parameters
1584
+
1585
+ Name | Type | Description | Notes
1586
+ ------------- | ------------- | ------------- | -------------
1587
+ **id** | **String**| |
1588
+ **limit** | **Integer**| | [optional]
1589
+ **starting_after** | **String**| | [optional]
1590
+ **ending_before** | **String**| | [optional]
1591
+
1592
+ ### Return type
1593
+
1594
+ [**SchoolsResponse**](SchoolsResponse.md)
1595
+
1596
+ ### Authorization
1597
+
1598
+ [oauth](../README.md#oauth)
1599
+
1600
+ ### HTTP request headers
1601
+
1602
+ - **Content-Type**: Not defined
1603
+ - **Accept**: application/json
1604
+
1605
+
1606
+
1607
+ # **get_section**
1608
+ > SectionResponse get_section(id)
1609
+
1610
+
1611
+
1612
+ Returns a specific section
1613
+
1614
+ ### Example
1615
+ ```ruby
1616
+ # load the gem
1617
+ require 'clever-ruby'
1618
+ # setup authorization
1619
+ Clever.configure do |config|
1620
+ # Configure OAuth2 access token for authorization: oauth
1621
+ config.access_token = 'YOUR ACCESS TOKEN'
1622
+ end
1623
+
1624
+ api_instance = Clever::DataApi.new
1625
+
1626
+ id = 'id_example' # String |
1627
+
1628
+
1629
+ begin
1630
+ result = api_instance.get_section(id)
1631
+ p result
1632
+ rescue Clever::ApiError => e
1633
+ puts "Exception when calling DataApi->get_section: #{e}"
1634
+ end
1635
+ ```
1636
+
1637
+ ### Parameters
1638
+
1639
+ Name | Type | Description | Notes
1640
+ ------------- | ------------- | ------------- | -------------
1641
+ **id** | **String**| |
1642
+
1643
+ ### Return type
1644
+
1645
+ [**SectionResponse**](SectionResponse.md)
1646
+
1647
+ ### Authorization
1648
+
1649
+ [oauth](../README.md#oauth)
1650
+
1651
+ ### HTTP request headers
1652
+
1653
+ - **Content-Type**: Not defined
1654
+ - **Accept**: application/json
1655
+
1656
+
1657
+
1658
+ # **get_sections**
1659
+ > SectionsResponse get_sections(opts)
1660
+
1661
+
1662
+
1663
+ Returns a list of sections
1664
+
1665
+ ### Example
1666
+ ```ruby
1667
+ # load the gem
1668
+ require 'clever-ruby'
1669
+ # setup authorization
1670
+ Clever.configure do |config|
1671
+ # Configure OAuth2 access token for authorization: oauth
1672
+ config.access_token = 'YOUR ACCESS TOKEN'
1673
+ end
1674
+
1675
+ api_instance = Clever::DataApi.new
1676
+
1677
+ opts = {
1678
+ limit: 56, # Integer |
1679
+ starting_after: 'starting_after_example', # String |
1680
+ ending_before: 'ending_before_example', # String |
1681
+ count: 'count_example' # String |
1682
+ }
1683
+
1684
+ begin
1685
+ result = api_instance.get_sections(opts)
1686
+ p result
1687
+ rescue Clever::ApiError => e
1688
+ puts "Exception when calling DataApi->get_sections: #{e}"
1689
+ end
1690
+ ```
1691
+
1692
+ ### Parameters
1693
+
1694
+ Name | Type | Description | Notes
1695
+ ------------- | ------------- | ------------- | -------------
1696
+ **limit** | **Integer**| | [optional]
1697
+ **starting_after** | **String**| | [optional]
1698
+ **ending_before** | **String**| | [optional]
1699
+ **count** | **String**| | [optional]
1700
+
1701
+ ### Return type
1702
+
1703
+ [**SectionsResponse**](SectionsResponse.md)
1704
+
1705
+ ### Authorization
1706
+
1707
+ [oauth](../README.md#oauth)
1708
+
1709
+ ### HTTP request headers
1710
+
1711
+ - **Content-Type**: Not defined
1712
+ - **Accept**: application/json
1713
+
1714
+
1715
+
1716
+ # **get_sections_for_course**
1717
+ > SectionsResponse get_sections_for_course(id, opts)
1718
+
1719
+
1720
+
1721
+ Returns the sections for a Courses
1722
+
1723
+ ### Example
1724
+ ```ruby
1725
+ # load the gem
1726
+ require 'clever-ruby'
1727
+ # setup authorization
1728
+ Clever.configure do |config|
1729
+ # Configure OAuth2 access token for authorization: oauth
1730
+ config.access_token = 'YOUR ACCESS TOKEN'
1731
+ end
1732
+
1733
+ api_instance = Clever::DataApi.new
1734
+
1735
+ id = 'id_example' # String |
1736
+
1737
+ opts = {
1738
+ limit: 56, # Integer |
1739
+ starting_after: 'starting_after_example', # String |
1740
+ ending_before: 'ending_before_example' # String |
1741
+ }
1742
+
1743
+ begin
1744
+ result = api_instance.get_sections_for_course(id, opts)
1745
+ p result
1746
+ rescue Clever::ApiError => e
1747
+ puts "Exception when calling DataApi->get_sections_for_course: #{e}"
1748
+ end
1749
+ ```
1750
+
1751
+ ### Parameters
1752
+
1753
+ Name | Type | Description | Notes
1754
+ ------------- | ------------- | ------------- | -------------
1755
+ **id** | **String**| |
1756
+ **limit** | **Integer**| | [optional]
1757
+ **starting_after** | **String**| | [optional]
1758
+ **ending_before** | **String**| | [optional]
1759
+
1760
+ ### Return type
1761
+
1762
+ [**SectionsResponse**](SectionsResponse.md)
1763
+
1764
+ ### Authorization
1765
+
1766
+ [oauth](../README.md#oauth)
1767
+
1768
+ ### HTTP request headers
1769
+
1770
+ - **Content-Type**: Not defined
1771
+ - **Accept**: application/json
1772
+
1773
+
1774
+
1775
+ # **get_sections_for_school**
1776
+ > SectionsResponse get_sections_for_school(id, opts)
1777
+
1778
+
1779
+
1780
+ Returns the sections for a school
1781
+
1782
+ ### Example
1783
+ ```ruby
1784
+ # load the gem
1785
+ require 'clever-ruby'
1786
+ # setup authorization
1787
+ Clever.configure do |config|
1788
+ # Configure OAuth2 access token for authorization: oauth
1789
+ config.access_token = 'YOUR ACCESS TOKEN'
1790
+ end
1791
+
1792
+ api_instance = Clever::DataApi.new
1793
+
1794
+ id = 'id_example' # String |
1795
+
1796
+ opts = {
1797
+ limit: 56, # Integer |
1798
+ starting_after: 'starting_after_example', # String |
1799
+ ending_before: 'ending_before_example' # String |
1800
+ }
1801
+
1802
+ begin
1803
+ result = api_instance.get_sections_for_school(id, opts)
1804
+ p result
1805
+ rescue Clever::ApiError => e
1806
+ puts "Exception when calling DataApi->get_sections_for_school: #{e}"
1807
+ end
1808
+ ```
1809
+
1810
+ ### Parameters
1811
+
1812
+ Name | Type | Description | Notes
1813
+ ------------- | ------------- | ------------- | -------------
1814
+ **id** | **String**| |
1815
+ **limit** | **Integer**| | [optional]
1816
+ **starting_after** | **String**| | [optional]
1817
+ **ending_before** | **String**| | [optional]
1818
+
1819
+ ### Return type
1820
+
1821
+ [**SectionsResponse**](SectionsResponse.md)
1822
+
1823
+ ### Authorization
1824
+
1825
+ [oauth](../README.md#oauth)
1826
+
1827
+ ### HTTP request headers
1828
+
1829
+ - **Content-Type**: Not defined
1830
+ - **Accept**: application/json
1831
+
1832
+
1833
+
1834
+ # **get_sections_for_student**
1835
+ > SectionsResponse get_sections_for_student(id, opts)
1836
+
1837
+
1838
+
1839
+ Returns the sections for a student
1840
+
1841
+ ### Example
1842
+ ```ruby
1843
+ # load the gem
1844
+ require 'clever-ruby'
1845
+ # setup authorization
1846
+ Clever.configure do |config|
1847
+ # Configure OAuth2 access token for authorization: oauth
1848
+ config.access_token = 'YOUR ACCESS TOKEN'
1849
+ end
1850
+
1851
+ api_instance = Clever::DataApi.new
1852
+
1853
+ id = 'id_example' # String |
1854
+
1855
+ opts = {
1856
+ limit: 56, # Integer |
1857
+ starting_after: 'starting_after_example', # String |
1858
+ ending_before: 'ending_before_example' # String |
1859
+ }
1860
+
1861
+ begin
1862
+ result = api_instance.get_sections_for_student(id, opts)
1863
+ p result
1864
+ rescue Clever::ApiError => e
1865
+ puts "Exception when calling DataApi->get_sections_for_student: #{e}"
1866
+ end
1867
+ ```
1868
+
1869
+ ### Parameters
1870
+
1871
+ Name | Type | Description | Notes
1872
+ ------------- | ------------- | ------------- | -------------
1873
+ **id** | **String**| |
1874
+ **limit** | **Integer**| | [optional]
1875
+ **starting_after** | **String**| | [optional]
1876
+ **ending_before** | **String**| | [optional]
1877
+
1878
+ ### Return type
1879
+
1880
+ [**SectionsResponse**](SectionsResponse.md)
1881
+
1882
+ ### Authorization
1883
+
1884
+ [oauth](../README.md#oauth)
1885
+
1886
+ ### HTTP request headers
1887
+
1888
+ - **Content-Type**: Not defined
1889
+ - **Accept**: application/json
1890
+
1891
+
1892
+
1893
+ # **get_sections_for_teacher**
1894
+ > SectionsResponse get_sections_for_teacher(id, opts)
1895
+
1896
+
1897
+
1898
+ Returns the sections for a teacher
1899
+
1900
+ ### Example
1901
+ ```ruby
1902
+ # load the gem
1903
+ require 'clever-ruby'
1904
+ # setup authorization
1905
+ Clever.configure do |config|
1906
+ # Configure OAuth2 access token for authorization: oauth
1907
+ config.access_token = 'YOUR ACCESS TOKEN'
1908
+ end
1909
+
1910
+ api_instance = Clever::DataApi.new
1911
+
1912
+ id = 'id_example' # String |
1913
+
1914
+ opts = {
1915
+ limit: 56, # Integer |
1916
+ starting_after: 'starting_after_example', # String |
1917
+ ending_before: 'ending_before_example' # String |
1918
+ }
1919
+
1920
+ begin
1921
+ result = api_instance.get_sections_for_teacher(id, opts)
1922
+ p result
1923
+ rescue Clever::ApiError => e
1924
+ puts "Exception when calling DataApi->get_sections_for_teacher: #{e}"
1925
+ end
1926
+ ```
1927
+
1928
+ ### Parameters
1929
+
1930
+ Name | Type | Description | Notes
1931
+ ------------- | ------------- | ------------- | -------------
1932
+ **id** | **String**| |
1933
+ **limit** | **Integer**| | [optional]
1934
+ **starting_after** | **String**| | [optional]
1935
+ **ending_before** | **String**| | [optional]
1936
+
1937
+ ### Return type
1938
+
1939
+ [**SectionsResponse**](SectionsResponse.md)
1940
+
1941
+ ### Authorization
1942
+
1943
+ [oauth](../README.md#oauth)
1944
+
1945
+ ### HTTP request headers
1946
+
1947
+ - **Content-Type**: Not defined
1948
+ - **Accept**: application/json
1949
+
1950
+
1951
+
1952
+ # **get_sections_for_term**
1953
+ > SectionsResponse get_sections_for_term(id, opts)
1954
+
1955
+
1956
+
1957
+ Returns the sections for a term
1958
+
1959
+ ### Example
1960
+ ```ruby
1961
+ # load the gem
1962
+ require 'clever-ruby'
1963
+ # setup authorization
1964
+ Clever.configure do |config|
1965
+ # Configure OAuth2 access token for authorization: oauth
1966
+ config.access_token = 'YOUR ACCESS TOKEN'
1967
+ end
1968
+
1969
+ api_instance = Clever::DataApi.new
1970
+
1971
+ id = 'id_example' # String |
1972
+
1973
+ opts = {
1974
+ limit: 56, # Integer |
1975
+ starting_after: 'starting_after_example', # String |
1976
+ ending_before: 'ending_before_example' # String |
1977
+ }
1978
+
1979
+ begin
1980
+ result = api_instance.get_sections_for_term(id, opts)
1981
+ p result
1982
+ rescue Clever::ApiError => e
1983
+ puts "Exception when calling DataApi->get_sections_for_term: #{e}"
1984
+ end
1985
+ ```
1986
+
1987
+ ### Parameters
1988
+
1989
+ Name | Type | Description | Notes
1990
+ ------------- | ------------- | ------------- | -------------
1991
+ **id** | **String**| |
1992
+ **limit** | **Integer**| | [optional]
1993
+ **starting_after** | **String**| | [optional]
1994
+ **ending_before** | **String**| | [optional]
1995
+
1996
+ ### Return type
1997
+
1998
+ [**SectionsResponse**](SectionsResponse.md)
1999
+
2000
+ ### Authorization
2001
+
2002
+ [oauth](../README.md#oauth)
2003
+
2004
+ ### HTTP request headers
2005
+
2006
+ - **Content-Type**: Not defined
2007
+ - **Accept**: application/json
2008
+
2009
+
2010
+
2011
+ # **get_student**
2012
+ > StudentResponse get_student(id)
2013
+
2014
+
2015
+
2016
+ Returns a specific student
2017
+
2018
+ ### Example
2019
+ ```ruby
2020
+ # load the gem
2021
+ require 'clever-ruby'
2022
+ # setup authorization
2023
+ Clever.configure do |config|
2024
+ # Configure OAuth2 access token for authorization: oauth
2025
+ config.access_token = 'YOUR ACCESS TOKEN'
2026
+ end
2027
+
2028
+ api_instance = Clever::DataApi.new
2029
+
2030
+ id = 'id_example' # String |
2031
+
2032
+
2033
+ begin
2034
+ result = api_instance.get_student(id)
2035
+ p result
2036
+ rescue Clever::ApiError => e
2037
+ puts "Exception when calling DataApi->get_student: #{e}"
2038
+ end
2039
+ ```
2040
+
2041
+ ### Parameters
2042
+
2043
+ Name | Type | Description | Notes
2044
+ ------------- | ------------- | ------------- | -------------
2045
+ **id** | **String**| |
2046
+
2047
+ ### Return type
2048
+
2049
+ [**StudentResponse**](StudentResponse.md)
2050
+
2051
+ ### Authorization
2052
+
2053
+ [oauth](../README.md#oauth)
2054
+
2055
+ ### HTTP request headers
2056
+
2057
+ - **Content-Type**: Not defined
2058
+ - **Accept**: application/json
2059
+
2060
+
2061
+
2062
+ # **get_students**
2063
+ > StudentsResponse get_students(opts)
2064
+
2065
+
2066
+
2067
+ Returns a list of students
2068
+
2069
+ ### Example
2070
+ ```ruby
2071
+ # load the gem
2072
+ require 'clever-ruby'
2073
+ # setup authorization
2074
+ Clever.configure do |config|
2075
+ # Configure OAuth2 access token for authorization: oauth
2076
+ config.access_token = 'YOUR ACCESS TOKEN'
2077
+ end
2078
+
2079
+ api_instance = Clever::DataApi.new
2080
+
2081
+ opts = {
2082
+ limit: 56, # Integer |
2083
+ starting_after: 'starting_after_example', # String |
2084
+ ending_before: 'ending_before_example', # String |
2085
+ count: 'count_example' # String |
2086
+ }
2087
+
2088
+ begin
2089
+ result = api_instance.get_students(opts)
2090
+ p result
2091
+ rescue Clever::ApiError => e
2092
+ puts "Exception when calling DataApi->get_students: #{e}"
2093
+ end
2094
+ ```
2095
+
2096
+ ### Parameters
2097
+
2098
+ Name | Type | Description | Notes
2099
+ ------------- | ------------- | ------------- | -------------
2100
+ **limit** | **Integer**| | [optional]
2101
+ **starting_after** | **String**| | [optional]
2102
+ **ending_before** | **String**| | [optional]
2103
+ **count** | **String**| | [optional]
2104
+
2105
+ ### Return type
2106
+
2107
+ [**StudentsResponse**](StudentsResponse.md)
2108
+
2109
+ ### Authorization
2110
+
2111
+ [oauth](../README.md#oauth)
2112
+
2113
+ ### HTTP request headers
2114
+
2115
+ - **Content-Type**: Not defined
2116
+ - **Accept**: application/json
2117
+
2118
+
2119
+
2120
+ # **get_students_for_contact**
2121
+ > StudentsResponse get_students_for_contact(id, opts)
2122
+
2123
+
2124
+
2125
+ Returns the students for a student contact
2126
+
2127
+ ### Example
2128
+ ```ruby
2129
+ # load the gem
2130
+ require 'clever-ruby'
2131
+ # setup authorization
2132
+ Clever.configure do |config|
2133
+ # Configure OAuth2 access token for authorization: oauth
2134
+ config.access_token = 'YOUR ACCESS TOKEN'
2135
+ end
2136
+
2137
+ api_instance = Clever::DataApi.new
2138
+
2139
+ id = 'id_example' # String |
2140
+
2141
+ opts = {
2142
+ limit: 56, # Integer |
2143
+ starting_after: 'starting_after_example', # String |
2144
+ ending_before: 'ending_before_example' # String |
2145
+ }
2146
+
2147
+ begin
2148
+ result = api_instance.get_students_for_contact(id, opts)
2149
+ p result
2150
+ rescue Clever::ApiError => e
2151
+ puts "Exception when calling DataApi->get_students_for_contact: #{e}"
2152
+ end
2153
+ ```
2154
+
2155
+ ### Parameters
2156
+
2157
+ Name | Type | Description | Notes
2158
+ ------------- | ------------- | ------------- | -------------
2159
+ **id** | **String**| |
2160
+ **limit** | **Integer**| | [optional]
2161
+ **starting_after** | **String**| | [optional]
2162
+ **ending_before** | **String**| | [optional]
2163
+
2164
+ ### Return type
2165
+
2166
+ [**StudentsResponse**](StudentsResponse.md)
2167
+
2168
+ ### Authorization
2169
+
2170
+ [oauth](../README.md#oauth)
2171
+
2172
+ ### HTTP request headers
2173
+
2174
+ - **Content-Type**: Not defined
2175
+ - **Accept**: application/json
2176
+
2177
+
2178
+
2179
+ # **get_students_for_school**
2180
+ > StudentsResponse get_students_for_school(id, opts)
2181
+
2182
+
2183
+
2184
+ Returns the students for a school
2185
+
2186
+ ### Example
2187
+ ```ruby
2188
+ # load the gem
2189
+ require 'clever-ruby'
2190
+ # setup authorization
2191
+ Clever.configure do |config|
2192
+ # Configure OAuth2 access token for authorization: oauth
2193
+ config.access_token = 'YOUR ACCESS TOKEN'
2194
+ end
2195
+
2196
+ api_instance = Clever::DataApi.new
2197
+
2198
+ id = 'id_example' # String |
2199
+
2200
+ opts = {
2201
+ limit: 56, # Integer |
2202
+ starting_after: 'starting_after_example', # String |
2203
+ ending_before: 'ending_before_example' # String |
2204
+ }
2205
+
2206
+ begin
2207
+ result = api_instance.get_students_for_school(id, opts)
2208
+ p result
2209
+ rescue Clever::ApiError => e
2210
+ puts "Exception when calling DataApi->get_students_for_school: #{e}"
2211
+ end
2212
+ ```
2213
+
2214
+ ### Parameters
2215
+
2216
+ Name | Type | Description | Notes
2217
+ ------------- | ------------- | ------------- | -------------
2218
+ **id** | **String**| |
2219
+ **limit** | **Integer**| | [optional]
2220
+ **starting_after** | **String**| | [optional]
2221
+ **ending_before** | **String**| | [optional]
2222
+
2223
+ ### Return type
2224
+
2225
+ [**StudentsResponse**](StudentsResponse.md)
2226
+
2227
+ ### Authorization
2228
+
2229
+ [oauth](../README.md#oauth)
2230
+
2231
+ ### HTTP request headers
2232
+
2233
+ - **Content-Type**: Not defined
2234
+ - **Accept**: application/json
2235
+
2236
+
2237
+
2238
+ # **get_students_for_section**
2239
+ > StudentsResponse get_students_for_section(id, opts)
2240
+
2241
+
2242
+
2243
+ Returns the students for a section
2244
+
2245
+ ### Example
2246
+ ```ruby
2247
+ # load the gem
2248
+ require 'clever-ruby'
2249
+ # setup authorization
2250
+ Clever.configure do |config|
2251
+ # Configure OAuth2 access token for authorization: oauth
2252
+ config.access_token = 'YOUR ACCESS TOKEN'
2253
+ end
2254
+
2255
+ api_instance = Clever::DataApi.new
2256
+
2257
+ id = 'id_example' # String |
2258
+
2259
+ opts = {
2260
+ limit: 56, # Integer |
2261
+ starting_after: 'starting_after_example', # String |
2262
+ ending_before: 'ending_before_example' # String |
2263
+ }
2264
+
2265
+ begin
2266
+ result = api_instance.get_students_for_section(id, opts)
2267
+ p result
2268
+ rescue Clever::ApiError => e
2269
+ puts "Exception when calling DataApi->get_students_for_section: #{e}"
2270
+ end
2271
+ ```
2272
+
2273
+ ### Parameters
2274
+
2275
+ Name | Type | Description | Notes
2276
+ ------------- | ------------- | ------------- | -------------
2277
+ **id** | **String**| |
2278
+ **limit** | **Integer**| | [optional]
2279
+ **starting_after** | **String**| | [optional]
2280
+ **ending_before** | **String**| | [optional]
2281
+
2282
+ ### Return type
2283
+
2284
+ [**StudentsResponse**](StudentsResponse.md)
2285
+
2286
+ ### Authorization
2287
+
2288
+ [oauth](../README.md#oauth)
2289
+
2290
+ ### HTTP request headers
2291
+
2292
+ - **Content-Type**: Not defined
2293
+ - **Accept**: application/json
2294
+
2295
+
2296
+
2297
+ # **get_students_for_teacher**
2298
+ > StudentsResponse get_students_for_teacher(id, opts)
2299
+
2300
+
2301
+
2302
+ Returns the students for a teacher
2303
+
2304
+ ### Example
2305
+ ```ruby
2306
+ # load the gem
2307
+ require 'clever-ruby'
2308
+ # setup authorization
2309
+ Clever.configure do |config|
2310
+ # Configure OAuth2 access token for authorization: oauth
2311
+ config.access_token = 'YOUR ACCESS TOKEN'
2312
+ end
2313
+
2314
+ api_instance = Clever::DataApi.new
2315
+
2316
+ id = 'id_example' # String |
2317
+
2318
+ opts = {
2319
+ limit: 56, # Integer |
2320
+ starting_after: 'starting_after_example', # String |
2321
+ ending_before: 'ending_before_example' # String |
2322
+ }
2323
+
2324
+ begin
2325
+ result = api_instance.get_students_for_teacher(id, opts)
2326
+ p result
2327
+ rescue Clever::ApiError => e
2328
+ puts "Exception when calling DataApi->get_students_for_teacher: #{e}"
2329
+ end
2330
+ ```
2331
+
2332
+ ### Parameters
2333
+
2334
+ Name | Type | Description | Notes
2335
+ ------------- | ------------- | ------------- | -------------
2336
+ **id** | **String**| |
2337
+ **limit** | **Integer**| | [optional]
2338
+ **starting_after** | **String**| | [optional]
2339
+ **ending_before** | **String**| | [optional]
2340
+
2341
+ ### Return type
2342
+
2343
+ [**StudentsResponse**](StudentsResponse.md)
2344
+
2345
+ ### Authorization
2346
+
2347
+ [oauth](../README.md#oauth)
2348
+
2349
+ ### HTTP request headers
2350
+
2351
+ - **Content-Type**: Not defined
2352
+ - **Accept**: application/json
2353
+
2354
+
2355
+
2356
+ # **get_teacher**
2357
+ > TeacherResponse get_teacher(id)
2358
+
2359
+
2360
+
2361
+ Returns a specific teacher
2362
+
2363
+ ### Example
2364
+ ```ruby
2365
+ # load the gem
2366
+ require 'clever-ruby'
2367
+ # setup authorization
2368
+ Clever.configure do |config|
2369
+ # Configure OAuth2 access token for authorization: oauth
2370
+ config.access_token = 'YOUR ACCESS TOKEN'
2371
+ end
2372
+
2373
+ api_instance = Clever::DataApi.new
2374
+
2375
+ id = 'id_example' # String |
2376
+
2377
+
2378
+ begin
2379
+ result = api_instance.get_teacher(id)
2380
+ p result
2381
+ rescue Clever::ApiError => e
2382
+ puts "Exception when calling DataApi->get_teacher: #{e}"
2383
+ end
2384
+ ```
2385
+
2386
+ ### Parameters
2387
+
2388
+ Name | Type | Description | Notes
2389
+ ------------- | ------------- | ------------- | -------------
2390
+ **id** | **String**| |
2391
+
2392
+ ### Return type
2393
+
2394
+ [**TeacherResponse**](TeacherResponse.md)
2395
+
2396
+ ### Authorization
2397
+
2398
+ [oauth](../README.md#oauth)
2399
+
2400
+ ### HTTP request headers
2401
+
2402
+ - **Content-Type**: Not defined
2403
+ - **Accept**: application/json
2404
+
2405
+
2406
+
2407
+ # **get_teacher_for_section**
2408
+ > TeacherResponse get_teacher_for_section(id)
2409
+
2410
+
2411
+
2412
+ Returns the primary teacher for a section
2413
+
2414
+ ### Example
2415
+ ```ruby
2416
+ # load the gem
2417
+ require 'clever-ruby'
2418
+ # setup authorization
2419
+ Clever.configure do |config|
2420
+ # Configure OAuth2 access token for authorization: oauth
2421
+ config.access_token = 'YOUR ACCESS TOKEN'
2422
+ end
2423
+
2424
+ api_instance = Clever::DataApi.new
2425
+
2426
+ id = 'id_example' # String |
2427
+
2428
+
2429
+ begin
2430
+ result = api_instance.get_teacher_for_section(id)
2431
+ p result
2432
+ rescue Clever::ApiError => e
2433
+ puts "Exception when calling DataApi->get_teacher_for_section: #{e}"
2434
+ end
2435
+ ```
2436
+
2437
+ ### Parameters
2438
+
2439
+ Name | Type | Description | Notes
2440
+ ------------- | ------------- | ------------- | -------------
2441
+ **id** | **String**| |
2442
+
2443
+ ### Return type
2444
+
2445
+ [**TeacherResponse**](TeacherResponse.md)
2446
+
2447
+ ### Authorization
2448
+
2449
+ [oauth](../README.md#oauth)
2450
+
2451
+ ### HTTP request headers
2452
+
2453
+ - **Content-Type**: Not defined
2454
+ - **Accept**: application/json
2455
+
2456
+
2457
+
2458
+ # **get_teachers**
2459
+ > TeachersResponse get_teachers(opts)
2460
+
2461
+
2462
+
2463
+ Returns a list of teachers
2464
+
2465
+ ### Example
2466
+ ```ruby
2467
+ # load the gem
2468
+ require 'clever-ruby'
2469
+ # setup authorization
2470
+ Clever.configure do |config|
2471
+ # Configure OAuth2 access token for authorization: oauth
2472
+ config.access_token = 'YOUR ACCESS TOKEN'
2473
+ end
2474
+
2475
+ api_instance = Clever::DataApi.new
2476
+
2477
+ opts = {
2478
+ limit: 56, # Integer |
2479
+ starting_after: 'starting_after_example', # String |
2480
+ ending_before: 'ending_before_example', # String |
2481
+ count: 'count_example' # String |
2482
+ }
2483
+
2484
+ begin
2485
+ result = api_instance.get_teachers(opts)
2486
+ p result
2487
+ rescue Clever::ApiError => e
2488
+ puts "Exception when calling DataApi->get_teachers: #{e}"
2489
+ end
2490
+ ```
2491
+
2492
+ ### Parameters
2493
+
2494
+ Name | Type | Description | Notes
2495
+ ------------- | ------------- | ------------- | -------------
2496
+ **limit** | **Integer**| | [optional]
2497
+ **starting_after** | **String**| | [optional]
2498
+ **ending_before** | **String**| | [optional]
2499
+ **count** | **String**| | [optional]
2500
+
2501
+ ### Return type
2502
+
2503
+ [**TeachersResponse**](TeachersResponse.md)
2504
+
2505
+ ### Authorization
2506
+
2507
+ [oauth](../README.md#oauth)
2508
+
2509
+ ### HTTP request headers
2510
+
2511
+ - **Content-Type**: Not defined
2512
+ - **Accept**: application/json
2513
+
2514
+
2515
+
2516
+ # **get_teachers_for_school**
2517
+ > TeachersResponse get_teachers_for_school(id, opts)
2518
+
2519
+
2520
+
2521
+ Returns the teachers for a school
2522
+
2523
+ ### Example
2524
+ ```ruby
2525
+ # load the gem
2526
+ require 'clever-ruby'
2527
+ # setup authorization
2528
+ Clever.configure do |config|
2529
+ # Configure OAuth2 access token for authorization: oauth
2530
+ config.access_token = 'YOUR ACCESS TOKEN'
2531
+ end
2532
+
2533
+ api_instance = Clever::DataApi.new
2534
+
2535
+ id = 'id_example' # String |
2536
+
2537
+ opts = {
2538
+ limit: 56, # Integer |
2539
+ starting_after: 'starting_after_example', # String |
2540
+ ending_before: 'ending_before_example' # String |
2541
+ }
2542
+
2543
+ begin
2544
+ result = api_instance.get_teachers_for_school(id, opts)
2545
+ p result
2546
+ rescue Clever::ApiError => e
2547
+ puts "Exception when calling DataApi->get_teachers_for_school: #{e}"
2548
+ end
2549
+ ```
2550
+
2551
+ ### Parameters
2552
+
2553
+ Name | Type | Description | Notes
2554
+ ------------- | ------------- | ------------- | -------------
2555
+ **id** | **String**| |
2556
+ **limit** | **Integer**| | [optional]
2557
+ **starting_after** | **String**| | [optional]
2558
+ **ending_before** | **String**| | [optional]
2559
+
2560
+ ### Return type
2561
+
2562
+ [**TeachersResponse**](TeachersResponse.md)
2563
+
2564
+ ### Authorization
2565
+
2566
+ [oauth](../README.md#oauth)
2567
+
2568
+ ### HTTP request headers
2569
+
2570
+ - **Content-Type**: Not defined
2571
+ - **Accept**: application/json
2572
+
2573
+
2574
+
2575
+ # **get_teachers_for_section**
2576
+ > TeachersResponse get_teachers_for_section(id, opts)
2577
+
2578
+
2579
+
2580
+ Returns the teachers for a section
2581
+
2582
+ ### Example
2583
+ ```ruby
2584
+ # load the gem
2585
+ require 'clever-ruby'
2586
+ # setup authorization
2587
+ Clever.configure do |config|
2588
+ # Configure OAuth2 access token for authorization: oauth
2589
+ config.access_token = 'YOUR ACCESS TOKEN'
2590
+ end
2591
+
2592
+ api_instance = Clever::DataApi.new
2593
+
2594
+ id = 'id_example' # String |
2595
+
2596
+ opts = {
2597
+ limit: 56, # Integer |
2598
+ starting_after: 'starting_after_example', # String |
2599
+ ending_before: 'ending_before_example' # String |
2600
+ }
2601
+
2602
+ begin
2603
+ result = api_instance.get_teachers_for_section(id, opts)
2604
+ p result
2605
+ rescue Clever::ApiError => e
2606
+ puts "Exception when calling DataApi->get_teachers_for_section: #{e}"
2607
+ end
2608
+ ```
2609
+
2610
+ ### Parameters
2611
+
2612
+ Name | Type | Description | Notes
2613
+ ------------- | ------------- | ------------- | -------------
2614
+ **id** | **String**| |
2615
+ **limit** | **Integer**| | [optional]
2616
+ **starting_after** | **String**| | [optional]
2617
+ **ending_before** | **String**| | [optional]
2618
+
2619
+ ### Return type
2620
+
2621
+ [**TeachersResponse**](TeachersResponse.md)
2622
+
2623
+ ### Authorization
2624
+
2625
+ [oauth](../README.md#oauth)
2626
+
2627
+ ### HTTP request headers
2628
+
2629
+ - **Content-Type**: Not defined
2630
+ - **Accept**: application/json
2631
+
2632
+
2633
+
2634
+ # **get_teachers_for_student**
2635
+ > TeachersResponse get_teachers_for_student(id, opts)
2636
+
2637
+
2638
+
2639
+ Returns the teachers for a student
2640
+
2641
+ ### Example
2642
+ ```ruby
2643
+ # load the gem
2644
+ require 'clever-ruby'
2645
+ # setup authorization
2646
+ Clever.configure do |config|
2647
+ # Configure OAuth2 access token for authorization: oauth
2648
+ config.access_token = 'YOUR ACCESS TOKEN'
2649
+ end
2650
+
2651
+ api_instance = Clever::DataApi.new
2652
+
2653
+ id = 'id_example' # String |
2654
+
2655
+ opts = {
2656
+ limit: 56, # Integer |
2657
+ starting_after: 'starting_after_example', # String |
2658
+ ending_before: 'ending_before_example' # String |
2659
+ }
2660
+
2661
+ begin
2662
+ result = api_instance.get_teachers_for_student(id, opts)
2663
+ p result
2664
+ rescue Clever::ApiError => e
2665
+ puts "Exception when calling DataApi->get_teachers_for_student: #{e}"
2666
+ end
2667
+ ```
2668
+
2669
+ ### Parameters
2670
+
2671
+ Name | Type | Description | Notes
2672
+ ------------- | ------------- | ------------- | -------------
2673
+ **id** | **String**| |
2674
+ **limit** | **Integer**| | [optional]
2675
+ **starting_after** | **String**| | [optional]
2676
+ **ending_before** | **String**| | [optional]
2677
+
2678
+ ### Return type
2679
+
2680
+ [**TeachersResponse**](TeachersResponse.md)
2681
+
2682
+ ### Authorization
2683
+
2684
+ [oauth](../README.md#oauth)
2685
+
2686
+ ### HTTP request headers
2687
+
2688
+ - **Content-Type**: Not defined
2689
+ - **Accept**: application/json
2690
+
2691
+
2692
+
2693
+ # **get_term**
2694
+ > TermResponse get_term(id)
2695
+
2696
+
2697
+
2698
+ Returns a specific term
2699
+
2700
+ ### Example
2701
+ ```ruby
2702
+ # load the gem
2703
+ require 'clever-ruby'
2704
+ # setup authorization
2705
+ Clever.configure do |config|
2706
+ # Configure OAuth2 access token for authorization: oauth
2707
+ config.access_token = 'YOUR ACCESS TOKEN'
2708
+ end
2709
+
2710
+ api_instance = Clever::DataApi.new
2711
+
2712
+ id = 'id_example' # String |
2713
+
2714
+
2715
+ begin
2716
+ result = api_instance.get_term(id)
2717
+ p result
2718
+ rescue Clever::ApiError => e
2719
+ puts "Exception when calling DataApi->get_term: #{e}"
2720
+ end
2721
+ ```
2722
+
2723
+ ### Parameters
2724
+
2725
+ Name | Type | Description | Notes
2726
+ ------------- | ------------- | ------------- | -------------
2727
+ **id** | **String**| |
2728
+
2729
+ ### Return type
2730
+
2731
+ [**TermResponse**](TermResponse.md)
2732
+
2733
+ ### Authorization
2734
+
2735
+ [oauth](../README.md#oauth)
2736
+
2737
+ ### HTTP request headers
2738
+
2739
+ - **Content-Type**: Not defined
2740
+ - **Accept**: application/json
2741
+
2742
+
2743
+
2744
+ # **get_term_for_section**
2745
+ > TermResponse get_term_for_section(id)
2746
+
2747
+
2748
+
2749
+ Returns the term for a section
2750
+
2751
+ ### Example
2752
+ ```ruby
2753
+ # load the gem
2754
+ require 'clever-ruby'
2755
+ # setup authorization
2756
+ Clever.configure do |config|
2757
+ # Configure OAuth2 access token for authorization: oauth
2758
+ config.access_token = 'YOUR ACCESS TOKEN'
2759
+ end
2760
+
2761
+ api_instance = Clever::DataApi.new
2762
+
2763
+ id = 'id_example' # String |
2764
+
2765
+
2766
+ begin
2767
+ result = api_instance.get_term_for_section(id)
2768
+ p result
2769
+ rescue Clever::ApiError => e
2770
+ puts "Exception when calling DataApi->get_term_for_section: #{e}"
2771
+ end
2772
+ ```
2773
+
2774
+ ### Parameters
2775
+
2776
+ Name | Type | Description | Notes
2777
+ ------------- | ------------- | ------------- | -------------
2778
+ **id** | **String**| |
2779
+
2780
+ ### Return type
2781
+
2782
+ [**TermResponse**](TermResponse.md)
2783
+
2784
+ ### Authorization
2785
+
2786
+ [oauth](../README.md#oauth)
2787
+
2788
+ ### HTTP request headers
2789
+
2790
+ - **Content-Type**: Not defined
2791
+ - **Accept**: application/json
2792
+
2793
+
2794
+
2795
+ # **get_terms**
2796
+ > TermsResponse get_terms(opts)
2797
+
2798
+
2799
+
2800
+ Returns a list of terms
2801
+
2802
+ ### Example
2803
+ ```ruby
2804
+ # load the gem
2805
+ require 'clever-ruby'
2806
+ # setup authorization
2807
+ Clever.configure do |config|
2808
+ # Configure OAuth2 access token for authorization: oauth
2809
+ config.access_token = 'YOUR ACCESS TOKEN'
2810
+ end
2811
+
2812
+ api_instance = Clever::DataApi.new
2813
+
2814
+ opts = {
2815
+ limit: 56, # Integer |
2816
+ starting_after: 'starting_after_example', # String |
2817
+ ending_before: 'ending_before_example', # String |
2818
+ count: 'count_example' # String |
2819
+ }
2820
+
2821
+ begin
2822
+ result = api_instance.get_terms(opts)
2823
+ p result
2824
+ rescue Clever::ApiError => e
2825
+ puts "Exception when calling DataApi->get_terms: #{e}"
2826
+ end
2827
+ ```
2828
+
2829
+ ### Parameters
2830
+
2831
+ Name | Type | Description | Notes
2832
+ ------------- | ------------- | ------------- | -------------
2833
+ **limit** | **Integer**| | [optional]
2834
+ **starting_after** | **String**| | [optional]
2835
+ **ending_before** | **String**| | [optional]
2836
+ **count** | **String**| | [optional]
2837
+
2838
+ ### Return type
2839
+
2840
+ [**TermsResponse**](TermsResponse.md)
2841
+
2842
+ ### Authorization
2843
+
2844
+ [oauth](../README.md#oauth)
2845
+
2846
+ ### HTTP request headers
2847
+
2848
+ - **Content-Type**: Not defined
2849
+ - **Accept**: application/json
2850
+
2851
+
2852
+