clever-ruby 0.14.0 → 1.0.0

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 (297) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/Gemfile +4 -1
  4. data/Makefile +10 -0
  5. data/README.md +175 -68
  6. data/Rakefile +6 -36
  7. data/circle.yml +1 -1
  8. data/clever-ruby.gemspec +43 -33
  9. data/docs/BadRequest.md +8 -0
  10. data/docs/DataApi.md +2144 -0
  11. data/docs/District.md +10 -0
  12. data/docs/DistrictAdmin.md +12 -0
  13. data/docs/DistrictAdminResponse.md +8 -0
  14. data/docs/DistrictAdminsResponse.md +8 -0
  15. data/docs/DistrictObject.md +8 -0
  16. data/docs/DistrictResponse.md +8 -0
  17. data/docs/DistrictStatus.md +15 -0
  18. data/docs/DistrictStatusResponse.md +8 -0
  19. data/docs/DistrictsCreated.md +10 -0
  20. data/docs/DistrictsDeleted.md +10 -0
  21. data/docs/DistrictsResponse.md +8 -0
  22. data/docs/DistrictsUpdated.md +10 -0
  23. data/docs/Event.md +9 -0
  24. data/docs/EventResponse.md +8 -0
  25. data/docs/EventsApi.md +424 -0
  26. data/docs/EventsResponse.md +8 -0
  27. data/docs/GradeLevelsResponse.md +8 -0
  28. data/docs/InternalError.md +8 -0
  29. data/docs/Location.md +13 -0
  30. data/docs/Name.md +10 -0
  31. data/docs/NotFound.md +8 -0
  32. data/docs/Principal.md +9 -0
  33. data/docs/School.md +22 -0
  34. data/docs/SchoolAdmin.md +14 -0
  35. data/docs/SchoolAdminObject.md +8 -0
  36. data/docs/SchoolAdminResponse.md +8 -0
  37. data/docs/SchoolAdminsResponse.md +8 -0
  38. data/docs/SchoolObject.md +8 -0
  39. data/docs/SchoolResponse.md +8 -0
  40. data/docs/SchooladminsCreated.md +10 -0
  41. data/docs/SchooladminsDeleted.md +10 -0
  42. data/docs/SchooladminsUpdated.md +10 -0
  43. data/docs/SchoolsCreated.md +10 -0
  44. data/docs/SchoolsDeleted.md +10 -0
  45. data/docs/SchoolsResponse.md +8 -0
  46. data/docs/SchoolsUpdated.md +10 -0
  47. data/docs/Section.md +25 -0
  48. data/docs/SectionObject.md +8 -0
  49. data/docs/SectionResponse.md +8 -0
  50. data/docs/SectionsCreated.md +10 -0
  51. data/docs/SectionsDeleted.md +10 -0
  52. data/docs/SectionsResponse.md +8 -0
  53. data/docs/SectionsUpdated.md +10 -0
  54. data/docs/Student.md +27 -0
  55. data/docs/StudentContact.md +16 -0
  56. data/docs/StudentContactObject.md +8 -0
  57. data/docs/StudentContactResponse.md +8 -0
  58. data/docs/StudentContactsResponse.md +8 -0
  59. data/docs/StudentObject.md +8 -0
  60. data/docs/StudentResponse.md +8 -0
  61. data/docs/StudentcontactsCreated.md +10 -0
  62. data/docs/StudentcontactsDeleted.md +10 -0
  63. data/docs/StudentcontactsUpdated.md +10 -0
  64. data/docs/StudentsCreated.md +10 -0
  65. data/docs/StudentsDeleted.md +10 -0
  66. data/docs/StudentsResponse.md +8 -0
  67. data/docs/StudentsUpdated.md +10 -0
  68. data/docs/Teacher.md +19 -0
  69. data/docs/TeacherObject.md +8 -0
  70. data/docs/TeacherResponse.md +8 -0
  71. data/docs/TeachersCreated.md +10 -0
  72. data/docs/TeachersDeleted.md +10 -0
  73. data/docs/TeachersResponse.md +8 -0
  74. data/docs/TeachersUpdated.md +10 -0
  75. data/docs/Term.md +10 -0
  76. data/git_push.sh +55 -0
  77. data/instructions.md +12 -0
  78. data/lib/clever-ruby.rb +89 -318
  79. data/lib/clever-ruby/api/data_api.rb +2090 -0
  80. data/lib/clever-ruby/api/events_api.rb +429 -0
  81. data/lib/clever-ruby/api_client.rb +401 -0
  82. data/lib/clever-ruby/api_error.rb +37 -0
  83. data/lib/clever-ruby/configuration.rb +187 -25
  84. data/lib/clever-ruby/models/bad_request.rb +187 -0
  85. data/lib/clever-ruby/models/district.rb +205 -0
  86. data/lib/clever-ruby/models/district_admin.rb +223 -0
  87. data/lib/clever-ruby/models/district_admin_response.rb +187 -0
  88. data/lib/clever-ruby/models/district_admins_response.rb +189 -0
  89. data/lib/clever-ruby/models/district_object.rb +187 -0
  90. data/lib/clever-ruby/models/district_response.rb +187 -0
  91. data/lib/clever-ruby/models/district_status.rb +250 -0
  92. data/lib/clever-ruby/models/district_status_response.rb +187 -0
  93. data/lib/clever-ruby/models/districts_created.rb +206 -0
  94. data/lib/clever-ruby/models/districts_deleted.rb +207 -0
  95. data/lib/clever-ruby/models/districts_response.rb +189 -0
  96. data/lib/clever-ruby/models/districts_updated.rb +207 -0
  97. data/lib/clever-ruby/models/event.rb +201 -0
  98. data/lib/clever-ruby/models/event_response.rb +187 -0
  99. data/lib/clever-ruby/models/events_response.rb +189 -0
  100. data/lib/clever-ruby/models/grade_levels_response.rb +189 -0
  101. data/lib/clever-ruby/models/internal_error.rb +187 -0
  102. data/lib/clever-ruby/models/location.rb +232 -0
  103. data/lib/clever-ruby/models/name.rb +205 -0
  104. data/lib/clever-ruby/models/not_found.rb +187 -0
  105. data/lib/clever-ruby/models/principal.rb +196 -0
  106. data/lib/clever-ruby/models/school.rb +313 -0
  107. data/lib/clever-ruby/models/school_admin.rb +243 -0
  108. data/lib/clever-ruby/models/school_admin_object.rb +187 -0
  109. data/lib/clever-ruby/models/school_admin_response.rb +187 -0
  110. data/lib/clever-ruby/models/school_admins_response.rb +189 -0
  111. data/lib/clever-ruby/models/school_object.rb +187 -0
  112. data/lib/clever-ruby/models/school_response.rb +187 -0
  113. data/lib/clever-ruby/models/schooladmins_created.rb +207 -0
  114. data/lib/clever-ruby/models/schooladmins_deleted.rb +207 -0
  115. data/lib/clever-ruby/models/schooladmins_updated.rb +207 -0
  116. data/lib/clever-ruby/models/schools_created.rb +207 -0
  117. data/lib/clever-ruby/models/schools_deleted.rb +207 -0
  118. data/lib/clever-ruby/models/schools_response.rb +189 -0
  119. data/lib/clever-ruby/models/schools_updated.rb +207 -0
  120. data/lib/clever-ruby/models/section.rb +344 -0
  121. data/lib/clever-ruby/models/section_object.rb +187 -0
  122. data/lib/clever-ruby/models/section_response.rb +187 -0
  123. data/lib/clever-ruby/models/sections_created.rb +207 -0
  124. data/lib/clever-ruby/models/sections_deleted.rb +207 -0
  125. data/lib/clever-ruby/models/sections_response.rb +189 -0
  126. data/lib/clever-ruby/models/sections_updated.rb +207 -0
  127. data/lib/clever-ruby/models/student.rb +360 -0
  128. data/lib/clever-ruby/models/student_contact.rb +259 -0
  129. data/lib/clever-ruby/models/student_contact_object.rb +187 -0
  130. data/lib/clever-ruby/models/student_contact_response.rb +187 -0
  131. data/lib/clever-ruby/models/student_contacts_response.rb +189 -0
  132. data/lib/clever-ruby/models/student_object.rb +187 -0
  133. data/lib/clever-ruby/models/student_response.rb +187 -0
  134. data/lib/clever-ruby/models/studentcontacts_created.rb +207 -0
  135. data/lib/clever-ruby/models/studentcontacts_deleted.rb +207 -0
  136. data/lib/clever-ruby/models/studentcontacts_updated.rb +207 -0
  137. data/lib/clever-ruby/models/students_created.rb +196 -0
  138. data/lib/clever-ruby/models/students_deleted.rb +206 -0
  139. data/lib/clever-ruby/models/students_response.rb +189 -0
  140. data/lib/clever-ruby/models/students_updated.rb +207 -0
  141. data/lib/clever-ruby/models/teacher.rb +288 -0
  142. data/lib/clever-ruby/models/teacher_object.rb +187 -0
  143. data/lib/clever-ruby/models/teacher_response.rb +187 -0
  144. data/lib/clever-ruby/models/teachers_created.rb +207 -0
  145. data/lib/clever-ruby/models/teachers_deleted.rb +207 -0
  146. data/lib/clever-ruby/models/teachers_response.rb +189 -0
  147. data/lib/clever-ruby/models/teachers_updated.rb +207 -0
  148. data/lib/clever-ruby/models/term.rb +205 -0
  149. data/lib/clever-ruby/version.rb +12 -4
  150. data/override/api_client.rb +401 -0
  151. data/override/config.json +5 -0
  152. data/override/models/districts_created.rb +206 -0
  153. data/override/models/districts_deleted.rb +207 -0
  154. data/override/models/districts_updated.rb +207 -0
  155. data/override/models/schooladmins_created.rb +207 -0
  156. data/override/models/schooladmins_deleted.rb +207 -0
  157. data/override/models/schooladmins_updated.rb +207 -0
  158. data/override/models/schools_created.rb +207 -0
  159. data/override/models/schools_deleted.rb +207 -0
  160. data/override/models/schools_updated.rb +207 -0
  161. data/override/models/sections_created.rb +207 -0
  162. data/override/models/sections_deleted.rb +207 -0
  163. data/override/models/sections_updated.rb +207 -0
  164. data/override/models/studentcontacts_created.rb +207 -0
  165. data/override/models/studentcontacts_deleted.rb +207 -0
  166. data/override/models/studentcontacts_updated.rb +207 -0
  167. data/override/models/students_created.rb +196 -0
  168. data/override/models/students_deleted.rb +206 -0
  169. data/override/models/students_updated.rb +207 -0
  170. data/override/models/teachers_created.rb +207 -0
  171. data/override/models/teachers_deleted.rb +207 -0
  172. data/override/models/teachers_updated.rb +207 -0
  173. data/override/override.sh +9 -0
  174. data/sample/sample.rb +16 -0
  175. metadata +252 -293
  176. data/.document +0 -5
  177. data/.gitignore +0 -22
  178. data/.rubocop.yml +0 -4
  179. data/.yardopts +0 -2
  180. data/LICENSE.txt +0 -20
  181. data/lib/clever-ruby/api_operations/list.rb +0 -130
  182. data/lib/clever-ruby/api_operations/nested_list.rb +0 -95
  183. data/lib/clever-ruby/api_operations/page.rb +0 -71
  184. data/lib/clever-ruby/api_operations/pagelist.rb +0 -43
  185. data/lib/clever-ruby/api_operations/results_list.rb +0 -31
  186. data/lib/clever-ruby/api_resource.rb +0 -174
  187. data/lib/clever-ruby/clever_object.rb +0 -246
  188. data/lib/clever-ruby/district.rb +0 -75
  189. data/lib/clever-ruby/district_admin.rb +0 -45
  190. data/lib/clever-ruby/errors/api_connection_error.rb +0 -5
  191. data/lib/clever-ruby/errors/api_error.rb +0 -5
  192. data/lib/clever-ruby/errors/authentication_error.rb +0 -5
  193. data/lib/clever-ruby/errors/clever_error.rb +0 -52
  194. data/lib/clever-ruby/errors/invalid_request_error.rb +0 -17
  195. data/lib/clever-ruby/event.rb +0 -61
  196. data/lib/clever-ruby/json.rb +0 -34
  197. data/lib/clever-ruby/nested_resource.rb +0 -41
  198. data/lib/clever-ruby/school.rb +0 -17
  199. data/lib/clever-ruby/school_admin.rb +0 -19
  200. data/lib/clever-ruby/section.rb +0 -17
  201. data/lib/clever-ruby/student.rb +0 -30
  202. data/lib/clever-ruby/teacher.rb +0 -17
  203. data/lib/clever-ruby/util.rb +0 -108
  204. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_district_properly.yml +0 -52
  205. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_event_properly.yml +0 -52
  206. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_school_admin_properly.yml +0 -52
  207. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_school_properly.yml +0 -52
  208. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_section_properly.yml +0 -52
  209. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_student_properly.yml +0 -52
  210. data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_teacher_properly.yml +0 -52
  211. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district.yml +0 -101
  212. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district_admin.yml +0 -90
  213. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_event.yml +0 -124
  214. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school.yml +0 -113
  215. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school_admin.yml +0 -101
  216. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_section.yml +0 -368
  217. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_student.yml +0 -176
  218. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_teacher.yml +0 -191
  219. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_districts_by_page.yml +0 -101
  220. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_districts_with_multiple_ids.yml +0 -101
  221. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_events_by_page.yml +0 -122
  222. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_events_with_multiple_ids.yml +0 -131
  223. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_school_admins_by_page.yml +0 -101
  224. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_school_admins_with_multiple_ids.yml +0 -101
  225. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_schools_by_page.yml +0 -110
  226. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_schools_with_multiple_ids.yml +0 -116
  227. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_sections_by_page.yml +0 -1168
  228. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_sections_with_multiple_ids.yml +0 -163
  229. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_students_by_page.yml +0 -1207
  230. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_students_with_multiple_ids.yml +0 -127
  231. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_teachers_by_page.yml +0 -190
  232. data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_teachers_with_multiple_ids.yml +0 -131
  233. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_district.yml +0 -101
  234. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_event.yml +0 -122
  235. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_school.yml +0 -110
  236. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_school_admin.yml +0 -101
  237. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_section.yml +0 -1168
  238. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_student.yml +0 -1207
  239. data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_teacher.yml +0 -190
  240. data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_events.yml +0 -526
  241. data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_schools.yml +0 -240
  242. data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_sections.yml +0 -3674
  243. data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_students.yml +0 -2387
  244. data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_teachers.yml +0 -717
  245. data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_events.yml +0 -152
  246. data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_schools.yml +0 -211
  247. data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_sections.yml +0 -3649
  248. data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_students.yml +0 -2362
  249. data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_teachers.yml +0 -688
  250. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_events.yml +0 -89
  251. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_school_admins.yml +0 -101
  252. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_schools.yml +0 -164
  253. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_sections.yml +0 -1168
  254. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_students.yml +0 -1207
  255. data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_teachers.yml +0 -324
  256. data/test/data/vcr_cassettes/Clever_NestedResource/must_include_auth_token_in_linked_resources.yml +0 -197
  257. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_events.yml +0 -237
  258. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_schools.yml +0 -217
  259. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_sections.yml +0 -2333
  260. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_students.yml +0 -2411
  261. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_teachers.yml +0 -377
  262. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_admin_s_schools.yml +0 -205
  263. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_district.yml +0 -162
  264. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_events.yml +0 -215
  265. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_sections.yml +0 -1153
  266. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_students.yml +0 -1081
  267. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_teachers.yml +0 -283
  268. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_district.yml +0 -417
  269. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_events.yml +0 -470
  270. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_school.yml +0 -420
  271. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_students.yml +0 -482
  272. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_teacher.yml +0 -418
  273. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_district.yml +0 -226
  274. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_events.yml +0 -279
  275. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_school.yml +0 -229
  276. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_sections.yml +0 -301
  277. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_teachers.yml +0 -277
  278. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_district.yml +0 -240
  279. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_events.yml +0 -293
  280. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_school.yml +0 -243
  281. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_sections.yml +0 -321
  282. data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_students.yml +0 -323
  283. data/test/data/vcr_cassettes/Error_handling/raises_an_InvalidRequestError_when_given_a_bad_created_since.yml +0 -151
  284. data/test/data/vcr_cassettes/Optional_attributes/has_the_expected_value_for_an_optional_attribute_that_is_present.yml +0 -55
  285. data/test/data/vcr_cassettes/last_method/page/has_working_first_and_last_methods.yml +0 -800
  286. data/test/integration/api_operations/list_test.rb +0 -117
  287. data/test/integration/district_test.rb +0 -53
  288. data/test/integration/district_with_non_global_token_test.rb +0 -88
  289. data/test/integration/error_handling_test.rb +0 -17
  290. data/test/integration/last_test.rb +0 -56
  291. data/test/integration/nested_resource_test.rb +0 -31
  292. data/test/test_helper.rb +0 -18
  293. data/test/unit/api_resource_test.rb +0 -48
  294. data/test/unit/clever_test.rb +0 -65
  295. data/test/unit/configuration_test.rb +0 -37
  296. data/test/unit/event_test.rb +0 -57
  297. data/test/unit/optional_attributes_test.rb +0 -27
@@ -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,2144 @@
1
+ # Clever::DataApi
2
+
3
+ All URIs are relative to *https://api.clever.com/v1.2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} | Get only a specific studentcontact's information.
8
+ [**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts | Gets a list of student contacts you have access to.
9
+ [**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts | Retrieves all contacts for a student.
10
+ [**get_district**](DataApi.md#get_district) | **GET** /districts/{id} | Get only a specific district's information.
11
+ [**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} | Retrieves a district admin
12
+ [**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins | Retrieves all users with admin access to a district.
13
+ [**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district | Retrieves district information for a school.
14
+ [**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district | Retrieves district information for a section.
15
+ [**get_district_for_student**](DataApi.md#get_district_for_student) | **GET** /students/{id}/district | Retrieves district information for a student.
16
+ [**get_district_for_student_contact**](DataApi.md#get_district_for_student_contact) | **GET** /contacts/{id}/district | Retrieves the district for a contact.
17
+ [**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district | Retrieves district information for a teacher.
18
+ [**get_districts**](DataApi.md#get_districts) | **GET** /districts | Gets a list of districts you have access to.
19
+ [**get_grade_levels_for_teacher**](DataApi.md#get_grade_levels_for_teacher) | **GET** /teachers/{id}/grade_levels | Retrieves a list of all grade levels taught by a specific teacher.
20
+ [**get_school**](DataApi.md#get_school) | **GET** /schools/{id} | Get only a specific school's information.
21
+ [**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} | Get only a specific schooladmin's information.
22
+ [**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins | Gets a list of school_admins you have access to.
23
+ [**get_school_for_section**](DataApi.md#get_school_for_section) | **GET** /sections/{id}/school | Retrieves information about the school for a section
24
+ [**get_school_for_student**](DataApi.md#get_school_for_student) | **GET** /students/{id}/school | Retrieves information about the school for a student
25
+ [**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school | Retrieves information about the school for a teacher
26
+ [**get_schools**](DataApi.md#get_schools) | **GET** /schools | Gets a list of schools you have access to.
27
+ [**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools | Retrieves all schools for a school admin.
28
+ [**get_section**](DataApi.md#get_section) | **GET** /sections/{id} | Get only a specific section's information.
29
+ [**get_sections**](DataApi.md#get_sections) | **GET** /sections | Gets a list of sections you have access to.
30
+ [**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections | Retrieves a list of all sections for a specific school.
31
+ [**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections | Retrieves a list of all sections for a student.
32
+ [**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections | Retrieves a list of all sections for a teacher.
33
+ [**get_student**](DataApi.md#get_student) | **GET** /students/{id} | Get only a specific student's information.
34
+ [**get_student_for_contact**](DataApi.md#get_student_for_contact) | **GET** /contacts/{id}/student | Retrieves the student for a contact.
35
+ [**get_students**](DataApi.md#get_students) | **GET** /students | Gets a list of students you have access to.
36
+ [**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students | Retrieves a list of all students for a specific school.
37
+ [**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students | Retrieves a list of all the section's students.
38
+ [**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students | Retrieves all students that a teacher has in their sections.
39
+ [**get_teacher**](DataApi.md#get_teacher) | **GET** /teachers/{id} | Get only a specific teacher's information.
40
+ [**get_teacher_for_section**](DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher | Retrieves information about the primary teacher of a section.
41
+ [**get_teachers**](DataApi.md#get_teachers) | **GET** /teachers | Gets a list of teachers you have access to.
42
+ [**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers | Retrieves a list of all teachers for a specific school.
43
+ [**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers | Retrieves a list of all the section's teachers.
44
+ [**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers | Retrieves all teachers for a student.
45
+
46
+
47
+ # **get_contact**
48
+ > StudentContactResponse get_contact(id)
49
+
50
+ Get only a specific studentcontact's information.
51
+
52
+ Returns a specific student contact
53
+
54
+ ### Example
55
+ ```ruby
56
+ # load the gem
57
+ require 'clever-ruby'
58
+ # setup authorization
59
+ Clever.configure do |config|
60
+ # Configure OAuth2 access token for authorization: oauth
61
+ config.access_token = 'YOUR ACCESS TOKEN'
62
+ end
63
+
64
+ api_instance = Clever::DataApi.new
65
+
66
+ id = "id_example" # String |
67
+
68
+
69
+ begin
70
+ #Get only a specific studentcontact's information.
71
+ result = api_instance.get_contact(id)
72
+ p result
73
+ rescue Clever::ApiError => e
74
+ puts "Exception when calling DataApi->get_contact: #{e}"
75
+ end
76
+ ```
77
+
78
+ ### Parameters
79
+
80
+ Name | Type | Description | Notes
81
+ ------------- | ------------- | ------------- | -------------
82
+ **id** | **String**| |
83
+
84
+ ### Return type
85
+
86
+ [**StudentContactResponse**](StudentContactResponse.md)
87
+
88
+ ### Authorization
89
+
90
+ [oauth](../README.md#oauth)
91
+
92
+ ### HTTP request headers
93
+
94
+ - **Content-Type**: Not defined
95
+ - **Accept**: application/json
96
+
97
+
98
+
99
+ # **get_contacts**
100
+ > StudentContactsResponse get_contacts(opts)
101
+
102
+ Gets a list of student contacts you have access to.
103
+
104
+ Returns a list of student contacts
105
+
106
+ ### Example
107
+ ```ruby
108
+ # load the gem
109
+ require 'clever-ruby'
110
+ # setup authorization
111
+ Clever.configure do |config|
112
+ # Configure OAuth2 access token for authorization: oauth
113
+ config.access_token = 'YOUR ACCESS TOKEN'
114
+ end
115
+
116
+ api_instance = Clever::DataApi.new
117
+
118
+ opts = {
119
+ limit: 56, # Integer |
120
+ starting_after: "starting_after_example", # String |
121
+ ending_before: "ending_before_example" # String |
122
+ }
123
+
124
+ begin
125
+ #Gets a list of student contacts you have access to.
126
+ result = api_instance.get_contacts(opts)
127
+ p result
128
+ rescue Clever::ApiError => e
129
+ puts "Exception when calling DataApi->get_contacts: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ Name | Type | Description | Notes
136
+ ------------- | ------------- | ------------- | -------------
137
+ **limit** | **Integer**| | [optional]
138
+ **starting_after** | **String**| | [optional]
139
+ **ending_before** | **String**| | [optional]
140
+
141
+ ### Return type
142
+
143
+ [**StudentContactsResponse**](StudentContactsResponse.md)
144
+
145
+ ### Authorization
146
+
147
+ [oauth](../README.md#oauth)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
154
+
155
+
156
+ # **get_contacts_for_student**
157
+ > StudentContactsResponse get_contacts_for_student(id, opts)
158
+
159
+ Retrieves all contacts for a student.
160
+
161
+ Returns the contacts for a student
162
+
163
+ ### Example
164
+ ```ruby
165
+ # load the gem
166
+ require 'clever-ruby'
167
+ # setup authorization
168
+ Clever.configure do |config|
169
+ # Configure OAuth2 access token for authorization: oauth
170
+ config.access_token = 'YOUR ACCESS TOKEN'
171
+ end
172
+
173
+ api_instance = Clever::DataApi.new
174
+
175
+ id = "id_example" # String |
176
+
177
+ opts = {
178
+ limit: 56 # Integer |
179
+ }
180
+
181
+ begin
182
+ #Retrieves all contacts for a student.
183
+ result = api_instance.get_contacts_for_student(id, opts)
184
+ p result
185
+ rescue Clever::ApiError => e
186
+ puts "Exception when calling DataApi->get_contacts_for_student: #{e}"
187
+ end
188
+ ```
189
+
190
+ ### Parameters
191
+
192
+ Name | Type | Description | Notes
193
+ ------------- | ------------- | ------------- | -------------
194
+ **id** | **String**| |
195
+ **limit** | **Integer**| | [optional]
196
+
197
+ ### Return type
198
+
199
+ [**StudentContactsResponse**](StudentContactsResponse.md)
200
+
201
+ ### Authorization
202
+
203
+ [oauth](../README.md#oauth)
204
+
205
+ ### HTTP request headers
206
+
207
+ - **Content-Type**: Not defined
208
+ - **Accept**: application/json
209
+
210
+
211
+
212
+ # **get_district**
213
+ > DistrictResponse get_district(id)
214
+
215
+ Get only a specific district's information.
216
+
217
+ Returns a specific district
218
+
219
+ ### Example
220
+ ```ruby
221
+ # load the gem
222
+ require 'clever-ruby'
223
+ # setup authorization
224
+ Clever.configure do |config|
225
+ # Configure OAuth2 access token for authorization: oauth
226
+ config.access_token = 'YOUR ACCESS TOKEN'
227
+ end
228
+
229
+ api_instance = Clever::DataApi.new
230
+
231
+ id = "id_example" # String |
232
+
233
+
234
+ begin
235
+ #Get only a specific district's information.
236
+ result = api_instance.get_district(id)
237
+ p result
238
+ rescue Clever::ApiError => e
239
+ puts "Exception when calling DataApi->get_district: #{e}"
240
+ end
241
+ ```
242
+
243
+ ### Parameters
244
+
245
+ Name | Type | Description | Notes
246
+ ------------- | ------------- | ------------- | -------------
247
+ **id** | **String**| |
248
+
249
+ ### Return type
250
+
251
+ [**DistrictResponse**](DistrictResponse.md)
252
+
253
+ ### Authorization
254
+
255
+ [oauth](../README.md#oauth)
256
+
257
+ ### HTTP request headers
258
+
259
+ - **Content-Type**: Not defined
260
+ - **Accept**: application/json
261
+
262
+
263
+
264
+ # **get_district_admin**
265
+ > DistrictAdminResponse get_district_admin(id)
266
+
267
+ Retrieves a district admin
268
+
269
+ Returns a specific district admin
270
+
271
+ ### Example
272
+ ```ruby
273
+ # load the gem
274
+ require 'clever-ruby'
275
+ # setup authorization
276
+ Clever.configure do |config|
277
+ # Configure OAuth2 access token for authorization: oauth
278
+ config.access_token = 'YOUR ACCESS TOKEN'
279
+ end
280
+
281
+ api_instance = Clever::DataApi.new
282
+
283
+ id = "id_example" # String |
284
+
285
+
286
+ begin
287
+ #Retrieves a district admin
288
+ result = api_instance.get_district_admin(id)
289
+ p result
290
+ rescue Clever::ApiError => e
291
+ puts "Exception when calling DataApi->get_district_admin: #{e}"
292
+ end
293
+ ```
294
+
295
+ ### Parameters
296
+
297
+ Name | Type | Description | Notes
298
+ ------------- | ------------- | ------------- | -------------
299
+ **id** | **String**| |
300
+
301
+ ### Return type
302
+
303
+ [**DistrictAdminResponse**](DistrictAdminResponse.md)
304
+
305
+ ### Authorization
306
+
307
+ [oauth](../README.md#oauth)
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: Not defined
312
+ - **Accept**: application/json
313
+
314
+
315
+
316
+ # **get_district_admins**
317
+ > DistrictAdminsResponse get_district_admins(opts)
318
+
319
+ Retrieves all users with admin access to a district.
320
+
321
+ Returns a list of district admins
322
+
323
+ ### Example
324
+ ```ruby
325
+ # load the gem
326
+ require 'clever-ruby'
327
+ # setup authorization
328
+ Clever.configure do |config|
329
+ # Configure OAuth2 access token for authorization: oauth
330
+ config.access_token = 'YOUR ACCESS TOKEN'
331
+ end
332
+
333
+ api_instance = Clever::DataApi.new
334
+
335
+ opts = {
336
+ starting_after: "starting_after_example", # String |
337
+ ending_before: "ending_before_example" # String |
338
+ }
339
+
340
+ begin
341
+ #Retrieves all users with admin access to a district.
342
+ result = api_instance.get_district_admins(opts)
343
+ p result
344
+ rescue Clever::ApiError => e
345
+ puts "Exception when calling DataApi->get_district_admins: #{e}"
346
+ end
347
+ ```
348
+
349
+ ### Parameters
350
+
351
+ Name | Type | Description | Notes
352
+ ------------- | ------------- | ------------- | -------------
353
+ **starting_after** | **String**| | [optional]
354
+ **ending_before** | **String**| | [optional]
355
+
356
+ ### Return type
357
+
358
+ [**DistrictAdminsResponse**](DistrictAdminsResponse.md)
359
+
360
+ ### Authorization
361
+
362
+ [oauth](../README.md#oauth)
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: Not defined
367
+ - **Accept**: application/json
368
+
369
+
370
+
371
+ # **get_district_for_school**
372
+ > DistrictResponse get_district_for_school(id)
373
+
374
+ Retrieves district information for a school.
375
+
376
+ Returns the district for a school
377
+
378
+ ### Example
379
+ ```ruby
380
+ # load the gem
381
+ require 'clever-ruby'
382
+ # setup authorization
383
+ Clever.configure do |config|
384
+ # Configure OAuth2 access token for authorization: oauth
385
+ config.access_token = 'YOUR ACCESS TOKEN'
386
+ end
387
+
388
+ api_instance = Clever::DataApi.new
389
+
390
+ id = "id_example" # String |
391
+
392
+
393
+ begin
394
+ #Retrieves district information for a school.
395
+ result = api_instance.get_district_for_school(id)
396
+ p result
397
+ rescue Clever::ApiError => e
398
+ puts "Exception when calling DataApi->get_district_for_school: #{e}"
399
+ end
400
+ ```
401
+
402
+ ### Parameters
403
+
404
+ Name | Type | Description | Notes
405
+ ------------- | ------------- | ------------- | -------------
406
+ **id** | **String**| |
407
+
408
+ ### Return type
409
+
410
+ [**DistrictResponse**](DistrictResponse.md)
411
+
412
+ ### Authorization
413
+
414
+ [oauth](../README.md#oauth)
415
+
416
+ ### HTTP request headers
417
+
418
+ - **Content-Type**: Not defined
419
+ - **Accept**: application/json
420
+
421
+
422
+
423
+ # **get_district_for_section**
424
+ > DistrictResponse get_district_for_section(id)
425
+
426
+ Retrieves district information for a section.
427
+
428
+ Returns the district for a section
429
+
430
+ ### Example
431
+ ```ruby
432
+ # load the gem
433
+ require 'clever-ruby'
434
+ # setup authorization
435
+ Clever.configure do |config|
436
+ # Configure OAuth2 access token for authorization: oauth
437
+ config.access_token = 'YOUR ACCESS TOKEN'
438
+ end
439
+
440
+ api_instance = Clever::DataApi.new
441
+
442
+ id = "id_example" # String |
443
+
444
+
445
+ begin
446
+ #Retrieves district information for a section.
447
+ result = api_instance.get_district_for_section(id)
448
+ p result
449
+ rescue Clever::ApiError => e
450
+ puts "Exception when calling DataApi->get_district_for_section: #{e}"
451
+ end
452
+ ```
453
+
454
+ ### Parameters
455
+
456
+ Name | Type | Description | Notes
457
+ ------------- | ------------- | ------------- | -------------
458
+ **id** | **String**| |
459
+
460
+ ### Return type
461
+
462
+ [**DistrictResponse**](DistrictResponse.md)
463
+
464
+ ### Authorization
465
+
466
+ [oauth](../README.md#oauth)
467
+
468
+ ### HTTP request headers
469
+
470
+ - **Content-Type**: Not defined
471
+ - **Accept**: application/json
472
+
473
+
474
+
475
+ # **get_district_for_student**
476
+ > DistrictResponse get_district_for_student(id)
477
+
478
+ Retrieves district information for a student.
479
+
480
+ Returns the district for a student
481
+
482
+ ### Example
483
+ ```ruby
484
+ # load the gem
485
+ require 'clever-ruby'
486
+ # setup authorization
487
+ Clever.configure do |config|
488
+ # Configure OAuth2 access token for authorization: oauth
489
+ config.access_token = 'YOUR ACCESS TOKEN'
490
+ end
491
+
492
+ api_instance = Clever::DataApi.new
493
+
494
+ id = "id_example" # String |
495
+
496
+
497
+ begin
498
+ #Retrieves district information for a student.
499
+ result = api_instance.get_district_for_student(id)
500
+ p result
501
+ rescue Clever::ApiError => e
502
+ puts "Exception when calling DataApi->get_district_for_student: #{e}"
503
+ end
504
+ ```
505
+
506
+ ### Parameters
507
+
508
+ Name | Type | Description | Notes
509
+ ------------- | ------------- | ------------- | -------------
510
+ **id** | **String**| |
511
+
512
+ ### Return type
513
+
514
+ [**DistrictResponse**](DistrictResponse.md)
515
+
516
+ ### Authorization
517
+
518
+ [oauth](../README.md#oauth)
519
+
520
+ ### HTTP request headers
521
+
522
+ - **Content-Type**: Not defined
523
+ - **Accept**: application/json
524
+
525
+
526
+
527
+ # **get_district_for_student_contact**
528
+ > DistrictResponse get_district_for_student_contact(id)
529
+
530
+ Retrieves the district for a contact.
531
+
532
+ Returns the district for a student contact
533
+
534
+ ### Example
535
+ ```ruby
536
+ # load the gem
537
+ require 'clever-ruby'
538
+ # setup authorization
539
+ Clever.configure do |config|
540
+ # Configure OAuth2 access token for authorization: oauth
541
+ config.access_token = 'YOUR ACCESS TOKEN'
542
+ end
543
+
544
+ api_instance = Clever::DataApi.new
545
+
546
+ id = "id_example" # String |
547
+
548
+
549
+ begin
550
+ #Retrieves the district for a contact.
551
+ result = api_instance.get_district_for_student_contact(id)
552
+ p result
553
+ rescue Clever::ApiError => e
554
+ puts "Exception when calling DataApi->get_district_for_student_contact: #{e}"
555
+ end
556
+ ```
557
+
558
+ ### Parameters
559
+
560
+ Name | Type | Description | Notes
561
+ ------------- | ------------- | ------------- | -------------
562
+ **id** | **String**| |
563
+
564
+ ### Return type
565
+
566
+ [**DistrictResponse**](DistrictResponse.md)
567
+
568
+ ### Authorization
569
+
570
+ [oauth](../README.md#oauth)
571
+
572
+ ### HTTP request headers
573
+
574
+ - **Content-Type**: Not defined
575
+ - **Accept**: application/json
576
+
577
+
578
+
579
+ # **get_district_for_teacher**
580
+ > DistrictResponse get_district_for_teacher(id)
581
+
582
+ Retrieves district information for a teacher.
583
+
584
+ Returns the district for a teacher
585
+
586
+ ### Example
587
+ ```ruby
588
+ # load the gem
589
+ require 'clever-ruby'
590
+ # setup authorization
591
+ Clever.configure do |config|
592
+ # Configure OAuth2 access token for authorization: oauth
593
+ config.access_token = 'YOUR ACCESS TOKEN'
594
+ end
595
+
596
+ api_instance = Clever::DataApi.new
597
+
598
+ id = "id_example" # String |
599
+
600
+
601
+ begin
602
+ #Retrieves district information for a teacher.
603
+ result = api_instance.get_district_for_teacher(id)
604
+ p result
605
+ rescue Clever::ApiError => e
606
+ puts "Exception when calling DataApi->get_district_for_teacher: #{e}"
607
+ end
608
+ ```
609
+
610
+ ### Parameters
611
+
612
+ Name | Type | Description | Notes
613
+ ------------- | ------------- | ------------- | -------------
614
+ **id** | **String**| |
615
+
616
+ ### Return type
617
+
618
+ [**DistrictResponse**](DistrictResponse.md)
619
+
620
+ ### Authorization
621
+
622
+ [oauth](../README.md#oauth)
623
+
624
+ ### HTTP request headers
625
+
626
+ - **Content-Type**: Not defined
627
+ - **Accept**: application/json
628
+
629
+
630
+
631
+ # **get_districts**
632
+ > DistrictsResponse get_districts(opts)
633
+
634
+ Gets a list of districts you have access to.
635
+
636
+ Returns a list of districts
637
+
638
+ ### Example
639
+ ```ruby
640
+ # load the gem
641
+ require 'clever-ruby'
642
+ # setup authorization
643
+ Clever.configure do |config|
644
+ # Configure OAuth2 access token for authorization: oauth
645
+ config.access_token = 'YOUR ACCESS TOKEN'
646
+ end
647
+
648
+ api_instance = Clever::DataApi.new
649
+
650
+ opts = {
651
+ limit: 56, # Integer |
652
+ starting_after: "starting_after_example", # String |
653
+ ending_before: "ending_before_example" # String |
654
+ }
655
+
656
+ begin
657
+ #Gets a list of districts you have access to.
658
+ result = api_instance.get_districts(opts)
659
+ p result
660
+ rescue Clever::ApiError => e
661
+ puts "Exception when calling DataApi->get_districts: #{e}"
662
+ end
663
+ ```
664
+
665
+ ### Parameters
666
+
667
+ Name | Type | Description | Notes
668
+ ------------- | ------------- | ------------- | -------------
669
+ **limit** | **Integer**| | [optional]
670
+ **starting_after** | **String**| | [optional]
671
+ **ending_before** | **String**| | [optional]
672
+
673
+ ### Return type
674
+
675
+ [**DistrictsResponse**](DistrictsResponse.md)
676
+
677
+ ### Authorization
678
+
679
+ [oauth](../README.md#oauth)
680
+
681
+ ### HTTP request headers
682
+
683
+ - **Content-Type**: Not defined
684
+ - **Accept**: application/json
685
+
686
+
687
+
688
+ # **get_grade_levels_for_teacher**
689
+ > GradeLevelsResponse get_grade_levels_for_teacher(id)
690
+
691
+ Retrieves a list of all grade levels taught by a specific teacher.
692
+
693
+ Returns the grade levels for sections a teacher teaches
694
+
695
+ ### Example
696
+ ```ruby
697
+ # load the gem
698
+ require 'clever-ruby'
699
+ # setup authorization
700
+ Clever.configure do |config|
701
+ # Configure OAuth2 access token for authorization: oauth
702
+ config.access_token = 'YOUR ACCESS TOKEN'
703
+ end
704
+
705
+ api_instance = Clever::DataApi.new
706
+
707
+ id = "id_example" # String |
708
+
709
+
710
+ begin
711
+ #Retrieves a list of all grade levels taught by a specific teacher.
712
+ result = api_instance.get_grade_levels_for_teacher(id)
713
+ p result
714
+ rescue Clever::ApiError => e
715
+ puts "Exception when calling DataApi->get_grade_levels_for_teacher: #{e}"
716
+ end
717
+ ```
718
+
719
+ ### Parameters
720
+
721
+ Name | Type | Description | Notes
722
+ ------------- | ------------- | ------------- | -------------
723
+ **id** | **String**| |
724
+
725
+ ### Return type
726
+
727
+ [**GradeLevelsResponse**](GradeLevelsResponse.md)
728
+
729
+ ### Authorization
730
+
731
+ [oauth](../README.md#oauth)
732
+
733
+ ### HTTP request headers
734
+
735
+ - **Content-Type**: Not defined
736
+ - **Accept**: application/json
737
+
738
+
739
+
740
+ # **get_school**
741
+ > SchoolResponse get_school(id)
742
+
743
+ Get only a specific school's information.
744
+
745
+ Returns a specific school
746
+
747
+ ### Example
748
+ ```ruby
749
+ # load the gem
750
+ require 'clever-ruby'
751
+ # setup authorization
752
+ Clever.configure do |config|
753
+ # Configure OAuth2 access token for authorization: oauth
754
+ config.access_token = 'YOUR ACCESS TOKEN'
755
+ end
756
+
757
+ api_instance = Clever::DataApi.new
758
+
759
+ id = "id_example" # String |
760
+
761
+
762
+ begin
763
+ #Get only a specific school's information.
764
+ result = api_instance.get_school(id)
765
+ p result
766
+ rescue Clever::ApiError => e
767
+ puts "Exception when calling DataApi->get_school: #{e}"
768
+ end
769
+ ```
770
+
771
+ ### Parameters
772
+
773
+ Name | Type | Description | Notes
774
+ ------------- | ------------- | ------------- | -------------
775
+ **id** | **String**| |
776
+
777
+ ### Return type
778
+
779
+ [**SchoolResponse**](SchoolResponse.md)
780
+
781
+ ### Authorization
782
+
783
+ [oauth](../README.md#oauth)
784
+
785
+ ### HTTP request headers
786
+
787
+ - **Content-Type**: Not defined
788
+ - **Accept**: application/json
789
+
790
+
791
+
792
+ # **get_school_admin**
793
+ > SchoolAdminResponse get_school_admin(id)
794
+
795
+ Get only a specific schooladmin's information.
796
+
797
+ Returns a specific school admin
798
+
799
+ ### Example
800
+ ```ruby
801
+ # load the gem
802
+ require 'clever-ruby'
803
+ # setup authorization
804
+ Clever.configure do |config|
805
+ # Configure OAuth2 access token for authorization: oauth
806
+ config.access_token = 'YOUR ACCESS TOKEN'
807
+ end
808
+
809
+ api_instance = Clever::DataApi.new
810
+
811
+ id = "id_example" # String |
812
+
813
+
814
+ begin
815
+ #Get only a specific schooladmin's information.
816
+ result = api_instance.get_school_admin(id)
817
+ p result
818
+ rescue Clever::ApiError => e
819
+ puts "Exception when calling DataApi->get_school_admin: #{e}"
820
+ end
821
+ ```
822
+
823
+ ### Parameters
824
+
825
+ Name | Type | Description | Notes
826
+ ------------- | ------------- | ------------- | -------------
827
+ **id** | **String**| |
828
+
829
+ ### Return type
830
+
831
+ [**SchoolAdminResponse**](SchoolAdminResponse.md)
832
+
833
+ ### Authorization
834
+
835
+ [oauth](../README.md#oauth)
836
+
837
+ ### HTTP request headers
838
+
839
+ - **Content-Type**: Not defined
840
+ - **Accept**: application/json
841
+
842
+
843
+
844
+ # **get_school_admins**
845
+ > SchoolAdminsResponse get_school_admins(opts)
846
+
847
+ Gets a list of school_admins you have access to.
848
+
849
+ Returns a list of school admins
850
+
851
+ ### Example
852
+ ```ruby
853
+ # load the gem
854
+ require 'clever-ruby'
855
+ # setup authorization
856
+ Clever.configure do |config|
857
+ # Configure OAuth2 access token for authorization: oauth
858
+ config.access_token = 'YOUR ACCESS TOKEN'
859
+ end
860
+
861
+ api_instance = Clever::DataApi.new
862
+
863
+ opts = {
864
+ limit: 56, # Integer |
865
+ starting_after: "starting_after_example", # String |
866
+ ending_before: "ending_before_example" # String |
867
+ }
868
+
869
+ begin
870
+ #Gets a list of school_admins you have access to.
871
+ result = api_instance.get_school_admins(opts)
872
+ p result
873
+ rescue Clever::ApiError => e
874
+ puts "Exception when calling DataApi->get_school_admins: #{e}"
875
+ end
876
+ ```
877
+
878
+ ### Parameters
879
+
880
+ Name | Type | Description | Notes
881
+ ------------- | ------------- | ------------- | -------------
882
+ **limit** | **Integer**| | [optional]
883
+ **starting_after** | **String**| | [optional]
884
+ **ending_before** | **String**| | [optional]
885
+
886
+ ### Return type
887
+
888
+ [**SchoolAdminsResponse**](SchoolAdminsResponse.md)
889
+
890
+ ### Authorization
891
+
892
+ [oauth](../README.md#oauth)
893
+
894
+ ### HTTP request headers
895
+
896
+ - **Content-Type**: Not defined
897
+ - **Accept**: application/json
898
+
899
+
900
+
901
+ # **get_school_for_section**
902
+ > SchoolResponse get_school_for_section(id)
903
+
904
+ Retrieves information about the school for a section
905
+
906
+ Returns the school for a section
907
+
908
+ ### Example
909
+ ```ruby
910
+ # load the gem
911
+ require 'clever-ruby'
912
+ # setup authorization
913
+ Clever.configure do |config|
914
+ # Configure OAuth2 access token for authorization: oauth
915
+ config.access_token = 'YOUR ACCESS TOKEN'
916
+ end
917
+
918
+ api_instance = Clever::DataApi.new
919
+
920
+ id = "id_example" # String |
921
+
922
+
923
+ begin
924
+ #Retrieves information about the school for a section
925
+ result = api_instance.get_school_for_section(id)
926
+ p result
927
+ rescue Clever::ApiError => e
928
+ puts "Exception when calling DataApi->get_school_for_section: #{e}"
929
+ end
930
+ ```
931
+
932
+ ### Parameters
933
+
934
+ Name | Type | Description | Notes
935
+ ------------- | ------------- | ------------- | -------------
936
+ **id** | **String**| |
937
+
938
+ ### Return type
939
+
940
+ [**SchoolResponse**](SchoolResponse.md)
941
+
942
+ ### Authorization
943
+
944
+ [oauth](../README.md#oauth)
945
+
946
+ ### HTTP request headers
947
+
948
+ - **Content-Type**: Not defined
949
+ - **Accept**: application/json
950
+
951
+
952
+
953
+ # **get_school_for_student**
954
+ > SchoolResponse get_school_for_student(id)
955
+
956
+ Retrieves information about the school for a student
957
+
958
+ Returns the primary school for a student
959
+
960
+ ### Example
961
+ ```ruby
962
+ # load the gem
963
+ require 'clever-ruby'
964
+ # setup authorization
965
+ Clever.configure do |config|
966
+ # Configure OAuth2 access token for authorization: oauth
967
+ config.access_token = 'YOUR ACCESS TOKEN'
968
+ end
969
+
970
+ api_instance = Clever::DataApi.new
971
+
972
+ id = "id_example" # String |
973
+
974
+
975
+ begin
976
+ #Retrieves information about the school for a student
977
+ result = api_instance.get_school_for_student(id)
978
+ p result
979
+ rescue Clever::ApiError => e
980
+ puts "Exception when calling DataApi->get_school_for_student: #{e}"
981
+ end
982
+ ```
983
+
984
+ ### Parameters
985
+
986
+ Name | Type | Description | Notes
987
+ ------------- | ------------- | ------------- | -------------
988
+ **id** | **String**| |
989
+
990
+ ### Return type
991
+
992
+ [**SchoolResponse**](SchoolResponse.md)
993
+
994
+ ### Authorization
995
+
996
+ [oauth](../README.md#oauth)
997
+
998
+ ### HTTP request headers
999
+
1000
+ - **Content-Type**: Not defined
1001
+ - **Accept**: application/json
1002
+
1003
+
1004
+
1005
+ # **get_school_for_teacher**
1006
+ > SchoolResponse get_school_for_teacher(id)
1007
+
1008
+ Retrieves information about the school for a teacher
1009
+
1010
+ Retrieves school info for a teacher.
1011
+
1012
+ ### Example
1013
+ ```ruby
1014
+ # load the gem
1015
+ require 'clever-ruby'
1016
+ # setup authorization
1017
+ Clever.configure do |config|
1018
+ # Configure OAuth2 access token for authorization: oauth
1019
+ config.access_token = 'YOUR ACCESS TOKEN'
1020
+ end
1021
+
1022
+ api_instance = Clever::DataApi.new
1023
+
1024
+ id = "id_example" # String |
1025
+
1026
+
1027
+ begin
1028
+ #Retrieves information about the school for a teacher
1029
+ result = api_instance.get_school_for_teacher(id)
1030
+ p result
1031
+ rescue Clever::ApiError => e
1032
+ puts "Exception when calling DataApi->get_school_for_teacher: #{e}"
1033
+ end
1034
+ ```
1035
+
1036
+ ### Parameters
1037
+
1038
+ Name | Type | Description | Notes
1039
+ ------------- | ------------- | ------------- | -------------
1040
+ **id** | **String**| |
1041
+
1042
+ ### Return type
1043
+
1044
+ [**SchoolResponse**](SchoolResponse.md)
1045
+
1046
+ ### Authorization
1047
+
1048
+ [oauth](../README.md#oauth)
1049
+
1050
+ ### HTTP request headers
1051
+
1052
+ - **Content-Type**: Not defined
1053
+ - **Accept**: application/json
1054
+
1055
+
1056
+
1057
+ # **get_schools**
1058
+ > SchoolsResponse get_schools(opts)
1059
+
1060
+ Gets a list of schools you have access to.
1061
+
1062
+ Returns a list of schools
1063
+
1064
+ ### Example
1065
+ ```ruby
1066
+ # load the gem
1067
+ require 'clever-ruby'
1068
+ # setup authorization
1069
+ Clever.configure do |config|
1070
+ # Configure OAuth2 access token for authorization: oauth
1071
+ config.access_token = 'YOUR ACCESS TOKEN'
1072
+ end
1073
+
1074
+ api_instance = Clever::DataApi.new
1075
+
1076
+ opts = {
1077
+ limit: 56, # Integer |
1078
+ starting_after: "starting_after_example", # String |
1079
+ ending_before: "ending_before_example" # String |
1080
+ }
1081
+
1082
+ begin
1083
+ #Gets a list of schools you have access to.
1084
+ result = api_instance.get_schools(opts)
1085
+ p result
1086
+ rescue Clever::ApiError => e
1087
+ puts "Exception when calling DataApi->get_schools: #{e}"
1088
+ end
1089
+ ```
1090
+
1091
+ ### Parameters
1092
+
1093
+ Name | Type | Description | Notes
1094
+ ------------- | ------------- | ------------- | -------------
1095
+ **limit** | **Integer**| | [optional]
1096
+ **starting_after** | **String**| | [optional]
1097
+ **ending_before** | **String**| | [optional]
1098
+
1099
+ ### Return type
1100
+
1101
+ [**SchoolsResponse**](SchoolsResponse.md)
1102
+
1103
+ ### Authorization
1104
+
1105
+ [oauth](../README.md#oauth)
1106
+
1107
+ ### HTTP request headers
1108
+
1109
+ - **Content-Type**: Not defined
1110
+ - **Accept**: application/json
1111
+
1112
+
1113
+
1114
+ # **get_schools_for_school_admin**
1115
+ > SchoolsResponse get_schools_for_school_admin(id, opts)
1116
+
1117
+ Retrieves all schools for a school admin.
1118
+
1119
+ Returns the schools for a school admin
1120
+
1121
+ ### Example
1122
+ ```ruby
1123
+ # load the gem
1124
+ require 'clever-ruby'
1125
+ # setup authorization
1126
+ Clever.configure do |config|
1127
+ # Configure OAuth2 access token for authorization: oauth
1128
+ config.access_token = 'YOUR ACCESS TOKEN'
1129
+ end
1130
+
1131
+ api_instance = Clever::DataApi.new
1132
+
1133
+ id = "id_example" # String |
1134
+
1135
+ opts = {
1136
+ limit: 56, # Integer |
1137
+ starting_after: "starting_after_example", # String |
1138
+ ending_before: "ending_before_example" # String |
1139
+ }
1140
+
1141
+ begin
1142
+ #Retrieves all schools for a school admin.
1143
+ result = api_instance.get_schools_for_school_admin(id, opts)
1144
+ p result
1145
+ rescue Clever::ApiError => e
1146
+ puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}"
1147
+ end
1148
+ ```
1149
+
1150
+ ### Parameters
1151
+
1152
+ Name | Type | Description | Notes
1153
+ ------------- | ------------- | ------------- | -------------
1154
+ **id** | **String**| |
1155
+ **limit** | **Integer**| | [optional]
1156
+ **starting_after** | **String**| | [optional]
1157
+ **ending_before** | **String**| | [optional]
1158
+
1159
+ ### Return type
1160
+
1161
+ [**SchoolsResponse**](SchoolsResponse.md)
1162
+
1163
+ ### Authorization
1164
+
1165
+ [oauth](../README.md#oauth)
1166
+
1167
+ ### HTTP request headers
1168
+
1169
+ - **Content-Type**: Not defined
1170
+ - **Accept**: application/json
1171
+
1172
+
1173
+
1174
+ # **get_section**
1175
+ > SectionResponse get_section(id)
1176
+
1177
+ Get only a specific section's information.
1178
+
1179
+ Returns a specific section
1180
+
1181
+ ### Example
1182
+ ```ruby
1183
+ # load the gem
1184
+ require 'clever-ruby'
1185
+ # setup authorization
1186
+ Clever.configure do |config|
1187
+ # Configure OAuth2 access token for authorization: oauth
1188
+ config.access_token = 'YOUR ACCESS TOKEN'
1189
+ end
1190
+
1191
+ api_instance = Clever::DataApi.new
1192
+
1193
+ id = "id_example" # String |
1194
+
1195
+
1196
+ begin
1197
+ #Get only a specific section's information.
1198
+ result = api_instance.get_section(id)
1199
+ p result
1200
+ rescue Clever::ApiError => e
1201
+ puts "Exception when calling DataApi->get_section: #{e}"
1202
+ end
1203
+ ```
1204
+
1205
+ ### Parameters
1206
+
1207
+ Name | Type | Description | Notes
1208
+ ------------- | ------------- | ------------- | -------------
1209
+ **id** | **String**| |
1210
+
1211
+ ### Return type
1212
+
1213
+ [**SectionResponse**](SectionResponse.md)
1214
+
1215
+ ### Authorization
1216
+
1217
+ [oauth](../README.md#oauth)
1218
+
1219
+ ### HTTP request headers
1220
+
1221
+ - **Content-Type**: Not defined
1222
+ - **Accept**: application/json
1223
+
1224
+
1225
+
1226
+ # **get_sections**
1227
+ > SectionsResponse get_sections(opts)
1228
+
1229
+ Gets a list of sections you have access to.
1230
+
1231
+ Returns a list of sections
1232
+
1233
+ ### Example
1234
+ ```ruby
1235
+ # load the gem
1236
+ require 'clever-ruby'
1237
+ # setup authorization
1238
+ Clever.configure do |config|
1239
+ # Configure OAuth2 access token for authorization: oauth
1240
+ config.access_token = 'YOUR ACCESS TOKEN'
1241
+ end
1242
+
1243
+ api_instance = Clever::DataApi.new
1244
+
1245
+ opts = {
1246
+ limit: 56, # Integer |
1247
+ starting_after: "starting_after_example", # String |
1248
+ ending_before: "ending_before_example" # String |
1249
+ }
1250
+
1251
+ begin
1252
+ #Gets a list of sections you have access to.
1253
+ result = api_instance.get_sections(opts)
1254
+ p result
1255
+ rescue Clever::ApiError => e
1256
+ puts "Exception when calling DataApi->get_sections: #{e}"
1257
+ end
1258
+ ```
1259
+
1260
+ ### Parameters
1261
+
1262
+ Name | Type | Description | Notes
1263
+ ------------- | ------------- | ------------- | -------------
1264
+ **limit** | **Integer**| | [optional]
1265
+ **starting_after** | **String**| | [optional]
1266
+ **ending_before** | **String**| | [optional]
1267
+
1268
+ ### Return type
1269
+
1270
+ [**SectionsResponse**](SectionsResponse.md)
1271
+
1272
+ ### Authorization
1273
+
1274
+ [oauth](../README.md#oauth)
1275
+
1276
+ ### HTTP request headers
1277
+
1278
+ - **Content-Type**: Not defined
1279
+ - **Accept**: application/json
1280
+
1281
+
1282
+
1283
+ # **get_sections_for_school**
1284
+ > SectionsResponse get_sections_for_school(id, opts)
1285
+
1286
+ Retrieves a list of all sections for a specific school.
1287
+
1288
+ Returns the sections for a school
1289
+
1290
+ ### Example
1291
+ ```ruby
1292
+ # load the gem
1293
+ require 'clever-ruby'
1294
+ # setup authorization
1295
+ Clever.configure do |config|
1296
+ # Configure OAuth2 access token for authorization: oauth
1297
+ config.access_token = 'YOUR ACCESS TOKEN'
1298
+ end
1299
+
1300
+ api_instance = Clever::DataApi.new
1301
+
1302
+ id = "id_example" # String |
1303
+
1304
+ opts = {
1305
+ limit: 56, # Integer |
1306
+ starting_after: "starting_after_example", # String |
1307
+ ending_before: "ending_before_example" # String |
1308
+ }
1309
+
1310
+ begin
1311
+ #Retrieves a list of all sections for a specific school.
1312
+ result = api_instance.get_sections_for_school(id, opts)
1313
+ p result
1314
+ rescue Clever::ApiError => e
1315
+ puts "Exception when calling DataApi->get_sections_for_school: #{e}"
1316
+ end
1317
+ ```
1318
+
1319
+ ### Parameters
1320
+
1321
+ Name | Type | Description | Notes
1322
+ ------------- | ------------- | ------------- | -------------
1323
+ **id** | **String**| |
1324
+ **limit** | **Integer**| | [optional]
1325
+ **starting_after** | **String**| | [optional]
1326
+ **ending_before** | **String**| | [optional]
1327
+
1328
+ ### Return type
1329
+
1330
+ [**SectionsResponse**](SectionsResponse.md)
1331
+
1332
+ ### Authorization
1333
+
1334
+ [oauth](../README.md#oauth)
1335
+
1336
+ ### HTTP request headers
1337
+
1338
+ - **Content-Type**: Not defined
1339
+ - **Accept**: application/json
1340
+
1341
+
1342
+
1343
+ # **get_sections_for_student**
1344
+ > SectionsResponse get_sections_for_student(id, opts)
1345
+
1346
+ Retrieves a list of all sections for a student.
1347
+
1348
+ Returns the sections for a student
1349
+
1350
+ ### Example
1351
+ ```ruby
1352
+ # load the gem
1353
+ require 'clever-ruby'
1354
+ # setup authorization
1355
+ Clever.configure do |config|
1356
+ # Configure OAuth2 access token for authorization: oauth
1357
+ config.access_token = 'YOUR ACCESS TOKEN'
1358
+ end
1359
+
1360
+ api_instance = Clever::DataApi.new
1361
+
1362
+ id = "id_example" # String |
1363
+
1364
+ opts = {
1365
+ limit: 56, # Integer |
1366
+ starting_after: "starting_after_example", # String |
1367
+ ending_before: "ending_before_example" # String |
1368
+ }
1369
+
1370
+ begin
1371
+ #Retrieves a list of all sections for a student.
1372
+ result = api_instance.get_sections_for_student(id, opts)
1373
+ p result
1374
+ rescue Clever::ApiError => e
1375
+ puts "Exception when calling DataApi->get_sections_for_student: #{e}"
1376
+ end
1377
+ ```
1378
+
1379
+ ### Parameters
1380
+
1381
+ Name | Type | Description | Notes
1382
+ ------------- | ------------- | ------------- | -------------
1383
+ **id** | **String**| |
1384
+ **limit** | **Integer**| | [optional]
1385
+ **starting_after** | **String**| | [optional]
1386
+ **ending_before** | **String**| | [optional]
1387
+
1388
+ ### Return type
1389
+
1390
+ [**SectionsResponse**](SectionsResponse.md)
1391
+
1392
+ ### Authorization
1393
+
1394
+ [oauth](../README.md#oauth)
1395
+
1396
+ ### HTTP request headers
1397
+
1398
+ - **Content-Type**: Not defined
1399
+ - **Accept**: application/json
1400
+
1401
+
1402
+
1403
+ # **get_sections_for_teacher**
1404
+ > SectionsResponse get_sections_for_teacher(id, opts)
1405
+
1406
+ Retrieves a list of all sections for a teacher.
1407
+
1408
+ Returns the sections for a teacher
1409
+
1410
+ ### Example
1411
+ ```ruby
1412
+ # load the gem
1413
+ require 'clever-ruby'
1414
+ # setup authorization
1415
+ Clever.configure do |config|
1416
+ # Configure OAuth2 access token for authorization: oauth
1417
+ config.access_token = 'YOUR ACCESS TOKEN'
1418
+ end
1419
+
1420
+ api_instance = Clever::DataApi.new
1421
+
1422
+ id = "id_example" # String |
1423
+
1424
+ opts = {
1425
+ limit: 56, # Integer |
1426
+ starting_after: "starting_after_example", # String |
1427
+ ending_before: "ending_before_example" # String |
1428
+ }
1429
+
1430
+ begin
1431
+ #Retrieves a list of all sections for a teacher.
1432
+ result = api_instance.get_sections_for_teacher(id, opts)
1433
+ p result
1434
+ rescue Clever::ApiError => e
1435
+ puts "Exception when calling DataApi->get_sections_for_teacher: #{e}"
1436
+ end
1437
+ ```
1438
+
1439
+ ### Parameters
1440
+
1441
+ Name | Type | Description | Notes
1442
+ ------------- | ------------- | ------------- | -------------
1443
+ **id** | **String**| |
1444
+ **limit** | **Integer**| | [optional]
1445
+ **starting_after** | **String**| | [optional]
1446
+ **ending_before** | **String**| | [optional]
1447
+
1448
+ ### Return type
1449
+
1450
+ [**SectionsResponse**](SectionsResponse.md)
1451
+
1452
+ ### Authorization
1453
+
1454
+ [oauth](../README.md#oauth)
1455
+
1456
+ ### HTTP request headers
1457
+
1458
+ - **Content-Type**: Not defined
1459
+ - **Accept**: application/json
1460
+
1461
+
1462
+
1463
+ # **get_student**
1464
+ > StudentResponse get_student(id)
1465
+
1466
+ Get only a specific student's information.
1467
+
1468
+ Returns a specific student
1469
+
1470
+ ### Example
1471
+ ```ruby
1472
+ # load the gem
1473
+ require 'clever-ruby'
1474
+ # setup authorization
1475
+ Clever.configure do |config|
1476
+ # Configure OAuth2 access token for authorization: oauth
1477
+ config.access_token = 'YOUR ACCESS TOKEN'
1478
+ end
1479
+
1480
+ api_instance = Clever::DataApi.new
1481
+
1482
+ id = "id_example" # String |
1483
+
1484
+
1485
+ begin
1486
+ #Get only a specific student's information.
1487
+ result = api_instance.get_student(id)
1488
+ p result
1489
+ rescue Clever::ApiError => e
1490
+ puts "Exception when calling DataApi->get_student: #{e}"
1491
+ end
1492
+ ```
1493
+
1494
+ ### Parameters
1495
+
1496
+ Name | Type | Description | Notes
1497
+ ------------- | ------------- | ------------- | -------------
1498
+ **id** | **String**| |
1499
+
1500
+ ### Return type
1501
+
1502
+ [**StudentResponse**](StudentResponse.md)
1503
+
1504
+ ### Authorization
1505
+
1506
+ [oauth](../README.md#oauth)
1507
+
1508
+ ### HTTP request headers
1509
+
1510
+ - **Content-Type**: Not defined
1511
+ - **Accept**: application/json
1512
+
1513
+
1514
+
1515
+ # **get_student_for_contact**
1516
+ > StudentResponse get_student_for_contact(id)
1517
+
1518
+ Retrieves the student for a contact.
1519
+
1520
+ Returns the student for a student contact
1521
+
1522
+ ### Example
1523
+ ```ruby
1524
+ # load the gem
1525
+ require 'clever-ruby'
1526
+ # setup authorization
1527
+ Clever.configure do |config|
1528
+ # Configure OAuth2 access token for authorization: oauth
1529
+ config.access_token = 'YOUR ACCESS TOKEN'
1530
+ end
1531
+
1532
+ api_instance = Clever::DataApi.new
1533
+
1534
+ id = "id_example" # String |
1535
+
1536
+
1537
+ begin
1538
+ #Retrieves the student for a contact.
1539
+ result = api_instance.get_student_for_contact(id)
1540
+ p result
1541
+ rescue Clever::ApiError => e
1542
+ puts "Exception when calling DataApi->get_student_for_contact: #{e}"
1543
+ end
1544
+ ```
1545
+
1546
+ ### Parameters
1547
+
1548
+ Name | Type | Description | Notes
1549
+ ------------- | ------------- | ------------- | -------------
1550
+ **id** | **String**| |
1551
+
1552
+ ### Return type
1553
+
1554
+ [**StudentResponse**](StudentResponse.md)
1555
+
1556
+ ### Authorization
1557
+
1558
+ [oauth](../README.md#oauth)
1559
+
1560
+ ### HTTP request headers
1561
+
1562
+ - **Content-Type**: Not defined
1563
+ - **Accept**: application/json
1564
+
1565
+
1566
+
1567
+ # **get_students**
1568
+ > StudentsResponse get_students(opts)
1569
+
1570
+ Gets a list of students you have access to.
1571
+
1572
+ Returns a list of students
1573
+
1574
+ ### Example
1575
+ ```ruby
1576
+ # load the gem
1577
+ require 'clever-ruby'
1578
+ # setup authorization
1579
+ Clever.configure do |config|
1580
+ # Configure OAuth2 access token for authorization: oauth
1581
+ config.access_token = 'YOUR ACCESS TOKEN'
1582
+ end
1583
+
1584
+ api_instance = Clever::DataApi.new
1585
+
1586
+ opts = {
1587
+ limit: 56, # Integer |
1588
+ starting_after: "starting_after_example", # String |
1589
+ ending_before: "ending_before_example" # String |
1590
+ }
1591
+
1592
+ begin
1593
+ #Gets a list of students you have access to.
1594
+ result = api_instance.get_students(opts)
1595
+ p result
1596
+ rescue Clever::ApiError => e
1597
+ puts "Exception when calling DataApi->get_students: #{e}"
1598
+ end
1599
+ ```
1600
+
1601
+ ### Parameters
1602
+
1603
+ Name | Type | Description | Notes
1604
+ ------------- | ------------- | ------------- | -------------
1605
+ **limit** | **Integer**| | [optional]
1606
+ **starting_after** | **String**| | [optional]
1607
+ **ending_before** | **String**| | [optional]
1608
+
1609
+ ### Return type
1610
+
1611
+ [**StudentsResponse**](StudentsResponse.md)
1612
+
1613
+ ### Authorization
1614
+
1615
+ [oauth](../README.md#oauth)
1616
+
1617
+ ### HTTP request headers
1618
+
1619
+ - **Content-Type**: Not defined
1620
+ - **Accept**: application/json
1621
+
1622
+
1623
+
1624
+ # **get_students_for_school**
1625
+ > StudentsResponse get_students_for_school(id, opts)
1626
+
1627
+ Retrieves a list of all students for a specific school.
1628
+
1629
+ Returns the students for a school
1630
+
1631
+ ### Example
1632
+ ```ruby
1633
+ # load the gem
1634
+ require 'clever-ruby'
1635
+ # setup authorization
1636
+ Clever.configure do |config|
1637
+ # Configure OAuth2 access token for authorization: oauth
1638
+ config.access_token = 'YOUR ACCESS TOKEN'
1639
+ end
1640
+
1641
+ api_instance = Clever::DataApi.new
1642
+
1643
+ id = "id_example" # String |
1644
+
1645
+ opts = {
1646
+ limit: 56, # Integer |
1647
+ starting_after: "starting_after_example", # String |
1648
+ ending_before: "ending_before_example" # String |
1649
+ }
1650
+
1651
+ begin
1652
+ #Retrieves a list of all students for a specific school.
1653
+ result = api_instance.get_students_for_school(id, opts)
1654
+ p result
1655
+ rescue Clever::ApiError => e
1656
+ puts "Exception when calling DataApi->get_students_for_school: #{e}"
1657
+ end
1658
+ ```
1659
+
1660
+ ### Parameters
1661
+
1662
+ Name | Type | Description | Notes
1663
+ ------------- | ------------- | ------------- | -------------
1664
+ **id** | **String**| |
1665
+ **limit** | **Integer**| | [optional]
1666
+ **starting_after** | **String**| | [optional]
1667
+ **ending_before** | **String**| | [optional]
1668
+
1669
+ ### Return type
1670
+
1671
+ [**StudentsResponse**](StudentsResponse.md)
1672
+
1673
+ ### Authorization
1674
+
1675
+ [oauth](../README.md#oauth)
1676
+
1677
+ ### HTTP request headers
1678
+
1679
+ - **Content-Type**: Not defined
1680
+ - **Accept**: application/json
1681
+
1682
+
1683
+
1684
+ # **get_students_for_section**
1685
+ > StudentsResponse get_students_for_section(id, opts)
1686
+
1687
+ Retrieves a list of all the section's students.
1688
+
1689
+ Returns the students for a section
1690
+
1691
+ ### Example
1692
+ ```ruby
1693
+ # load the gem
1694
+ require 'clever-ruby'
1695
+ # setup authorization
1696
+ Clever.configure do |config|
1697
+ # Configure OAuth2 access token for authorization: oauth
1698
+ config.access_token = 'YOUR ACCESS TOKEN'
1699
+ end
1700
+
1701
+ api_instance = Clever::DataApi.new
1702
+
1703
+ id = "id_example" # String |
1704
+
1705
+ opts = {
1706
+ limit: 56, # Integer |
1707
+ starting_after: "starting_after_example", # String |
1708
+ ending_before: "ending_before_example" # String |
1709
+ }
1710
+
1711
+ begin
1712
+ #Retrieves a list of all the section's students.
1713
+ result = api_instance.get_students_for_section(id, opts)
1714
+ p result
1715
+ rescue Clever::ApiError => e
1716
+ puts "Exception when calling DataApi->get_students_for_section: #{e}"
1717
+ end
1718
+ ```
1719
+
1720
+ ### Parameters
1721
+
1722
+ Name | Type | Description | Notes
1723
+ ------------- | ------------- | ------------- | -------------
1724
+ **id** | **String**| |
1725
+ **limit** | **Integer**| | [optional]
1726
+ **starting_after** | **String**| | [optional]
1727
+ **ending_before** | **String**| | [optional]
1728
+
1729
+ ### Return type
1730
+
1731
+ [**StudentsResponse**](StudentsResponse.md)
1732
+
1733
+ ### Authorization
1734
+
1735
+ [oauth](../README.md#oauth)
1736
+
1737
+ ### HTTP request headers
1738
+
1739
+ - **Content-Type**: Not defined
1740
+ - **Accept**: application/json
1741
+
1742
+
1743
+
1744
+ # **get_students_for_teacher**
1745
+ > StudentsResponse get_students_for_teacher(id, opts)
1746
+
1747
+ Retrieves all students that a teacher has in their sections.
1748
+
1749
+ Returns the students for a teacher
1750
+
1751
+ ### Example
1752
+ ```ruby
1753
+ # load the gem
1754
+ require 'clever-ruby'
1755
+ # setup authorization
1756
+ Clever.configure do |config|
1757
+ # Configure OAuth2 access token for authorization: oauth
1758
+ config.access_token = 'YOUR ACCESS TOKEN'
1759
+ end
1760
+
1761
+ api_instance = Clever::DataApi.new
1762
+
1763
+ id = "id_example" # String |
1764
+
1765
+ opts = {
1766
+ limit: 56, # Integer |
1767
+ starting_after: "starting_after_example", # String |
1768
+ ending_before: "ending_before_example" # String |
1769
+ }
1770
+
1771
+ begin
1772
+ #Retrieves all students that a teacher has in their sections.
1773
+ result = api_instance.get_students_for_teacher(id, opts)
1774
+ p result
1775
+ rescue Clever::ApiError => e
1776
+ puts "Exception when calling DataApi->get_students_for_teacher: #{e}"
1777
+ end
1778
+ ```
1779
+
1780
+ ### Parameters
1781
+
1782
+ Name | Type | Description | Notes
1783
+ ------------- | ------------- | ------------- | -------------
1784
+ **id** | **String**| |
1785
+ **limit** | **Integer**| | [optional]
1786
+ **starting_after** | **String**| | [optional]
1787
+ **ending_before** | **String**| | [optional]
1788
+
1789
+ ### Return type
1790
+
1791
+ [**StudentsResponse**](StudentsResponse.md)
1792
+
1793
+ ### Authorization
1794
+
1795
+ [oauth](../README.md#oauth)
1796
+
1797
+ ### HTTP request headers
1798
+
1799
+ - **Content-Type**: Not defined
1800
+ - **Accept**: application/json
1801
+
1802
+
1803
+
1804
+ # **get_teacher**
1805
+ > TeacherResponse get_teacher(id)
1806
+
1807
+ Get only a specific teacher's information.
1808
+
1809
+ Returns a specific teacher
1810
+
1811
+ ### Example
1812
+ ```ruby
1813
+ # load the gem
1814
+ require 'clever-ruby'
1815
+ # setup authorization
1816
+ Clever.configure do |config|
1817
+ # Configure OAuth2 access token for authorization: oauth
1818
+ config.access_token = 'YOUR ACCESS TOKEN'
1819
+ end
1820
+
1821
+ api_instance = Clever::DataApi.new
1822
+
1823
+ id = "id_example" # String |
1824
+
1825
+
1826
+ begin
1827
+ #Get only a specific teacher's information.
1828
+ result = api_instance.get_teacher(id)
1829
+ p result
1830
+ rescue Clever::ApiError => e
1831
+ puts "Exception when calling DataApi->get_teacher: #{e}"
1832
+ end
1833
+ ```
1834
+
1835
+ ### Parameters
1836
+
1837
+ Name | Type | Description | Notes
1838
+ ------------- | ------------- | ------------- | -------------
1839
+ **id** | **String**| |
1840
+
1841
+ ### Return type
1842
+
1843
+ [**TeacherResponse**](TeacherResponse.md)
1844
+
1845
+ ### Authorization
1846
+
1847
+ [oauth](../README.md#oauth)
1848
+
1849
+ ### HTTP request headers
1850
+
1851
+ - **Content-Type**: Not defined
1852
+ - **Accept**: application/json
1853
+
1854
+
1855
+
1856
+ # **get_teacher_for_section**
1857
+ > TeacherResponse get_teacher_for_section(id)
1858
+
1859
+ Retrieves information about the primary teacher of a section.
1860
+
1861
+ Returns the primary teacher for a section
1862
+
1863
+ ### Example
1864
+ ```ruby
1865
+ # load the gem
1866
+ require 'clever-ruby'
1867
+ # setup authorization
1868
+ Clever.configure do |config|
1869
+ # Configure OAuth2 access token for authorization: oauth
1870
+ config.access_token = 'YOUR ACCESS TOKEN'
1871
+ end
1872
+
1873
+ api_instance = Clever::DataApi.new
1874
+
1875
+ id = "id_example" # String |
1876
+
1877
+
1878
+ begin
1879
+ #Retrieves information about the primary teacher of a section.
1880
+ result = api_instance.get_teacher_for_section(id)
1881
+ p result
1882
+ rescue Clever::ApiError => e
1883
+ puts "Exception when calling DataApi->get_teacher_for_section: #{e}"
1884
+ end
1885
+ ```
1886
+
1887
+ ### Parameters
1888
+
1889
+ Name | Type | Description | Notes
1890
+ ------------- | ------------- | ------------- | -------------
1891
+ **id** | **String**| |
1892
+
1893
+ ### Return type
1894
+
1895
+ [**TeacherResponse**](TeacherResponse.md)
1896
+
1897
+ ### Authorization
1898
+
1899
+ [oauth](../README.md#oauth)
1900
+
1901
+ ### HTTP request headers
1902
+
1903
+ - **Content-Type**: Not defined
1904
+ - **Accept**: application/json
1905
+
1906
+
1907
+
1908
+ # **get_teachers**
1909
+ > TeachersResponse get_teachers(opts)
1910
+
1911
+ Gets a list of teachers you have access to.
1912
+
1913
+ Returns a list of teachers
1914
+
1915
+ ### Example
1916
+ ```ruby
1917
+ # load the gem
1918
+ require 'clever-ruby'
1919
+ # setup authorization
1920
+ Clever.configure do |config|
1921
+ # Configure OAuth2 access token for authorization: oauth
1922
+ config.access_token = 'YOUR ACCESS TOKEN'
1923
+ end
1924
+
1925
+ api_instance = Clever::DataApi.new
1926
+
1927
+ opts = {
1928
+ limit: 56, # Integer |
1929
+ starting_after: "starting_after_example", # String |
1930
+ ending_before: "ending_before_example" # String |
1931
+ }
1932
+
1933
+ begin
1934
+ #Gets a list of teachers you have access to.
1935
+ result = api_instance.get_teachers(opts)
1936
+ p result
1937
+ rescue Clever::ApiError => e
1938
+ puts "Exception when calling DataApi->get_teachers: #{e}"
1939
+ end
1940
+ ```
1941
+
1942
+ ### Parameters
1943
+
1944
+ Name | Type | Description | Notes
1945
+ ------------- | ------------- | ------------- | -------------
1946
+ **limit** | **Integer**| | [optional]
1947
+ **starting_after** | **String**| | [optional]
1948
+ **ending_before** | **String**| | [optional]
1949
+
1950
+ ### Return type
1951
+
1952
+ [**TeachersResponse**](TeachersResponse.md)
1953
+
1954
+ ### Authorization
1955
+
1956
+ [oauth](../README.md#oauth)
1957
+
1958
+ ### HTTP request headers
1959
+
1960
+ - **Content-Type**: Not defined
1961
+ - **Accept**: application/json
1962
+
1963
+
1964
+
1965
+ # **get_teachers_for_school**
1966
+ > TeachersResponse get_teachers_for_school(id, opts)
1967
+
1968
+ Retrieves a list of all teachers for a specific school.
1969
+
1970
+ Returns the teachers for a school
1971
+
1972
+ ### Example
1973
+ ```ruby
1974
+ # load the gem
1975
+ require 'clever-ruby'
1976
+ # setup authorization
1977
+ Clever.configure do |config|
1978
+ # Configure OAuth2 access token for authorization: oauth
1979
+ config.access_token = 'YOUR ACCESS TOKEN'
1980
+ end
1981
+
1982
+ api_instance = Clever::DataApi.new
1983
+
1984
+ id = "id_example" # String |
1985
+
1986
+ opts = {
1987
+ limit: 56, # Integer |
1988
+ starting_after: "starting_after_example", # String |
1989
+ ending_before: "ending_before_example" # String |
1990
+ }
1991
+
1992
+ begin
1993
+ #Retrieves a list of all teachers for a specific school.
1994
+ result = api_instance.get_teachers_for_school(id, opts)
1995
+ p result
1996
+ rescue Clever::ApiError => e
1997
+ puts "Exception when calling DataApi->get_teachers_for_school: #{e}"
1998
+ end
1999
+ ```
2000
+
2001
+ ### Parameters
2002
+
2003
+ Name | Type | Description | Notes
2004
+ ------------- | ------------- | ------------- | -------------
2005
+ **id** | **String**| |
2006
+ **limit** | **Integer**| | [optional]
2007
+ **starting_after** | **String**| | [optional]
2008
+ **ending_before** | **String**| | [optional]
2009
+
2010
+ ### Return type
2011
+
2012
+ [**TeachersResponse**](TeachersResponse.md)
2013
+
2014
+ ### Authorization
2015
+
2016
+ [oauth](../README.md#oauth)
2017
+
2018
+ ### HTTP request headers
2019
+
2020
+ - **Content-Type**: Not defined
2021
+ - **Accept**: application/json
2022
+
2023
+
2024
+
2025
+ # **get_teachers_for_section**
2026
+ > TeachersResponse get_teachers_for_section(id, opts)
2027
+
2028
+ Retrieves a list of all the section's teachers.
2029
+
2030
+ Returns the teachers for a section
2031
+
2032
+ ### Example
2033
+ ```ruby
2034
+ # load the gem
2035
+ require 'clever-ruby'
2036
+ # setup authorization
2037
+ Clever.configure do |config|
2038
+ # Configure OAuth2 access token for authorization: oauth
2039
+ config.access_token = 'YOUR ACCESS TOKEN'
2040
+ end
2041
+
2042
+ api_instance = Clever::DataApi.new
2043
+
2044
+ id = "id_example" # String |
2045
+
2046
+ opts = {
2047
+ limit: 56, # Integer |
2048
+ starting_after: "starting_after_example", # String |
2049
+ ending_before: "ending_before_example" # String |
2050
+ }
2051
+
2052
+ begin
2053
+ #Retrieves a list of all the section's teachers.
2054
+ result = api_instance.get_teachers_for_section(id, opts)
2055
+ p result
2056
+ rescue Clever::ApiError => e
2057
+ puts "Exception when calling DataApi->get_teachers_for_section: #{e}"
2058
+ end
2059
+ ```
2060
+
2061
+ ### Parameters
2062
+
2063
+ Name | Type | Description | Notes
2064
+ ------------- | ------------- | ------------- | -------------
2065
+ **id** | **String**| |
2066
+ **limit** | **Integer**| | [optional]
2067
+ **starting_after** | **String**| | [optional]
2068
+ **ending_before** | **String**| | [optional]
2069
+
2070
+ ### Return type
2071
+
2072
+ [**TeachersResponse**](TeachersResponse.md)
2073
+
2074
+ ### Authorization
2075
+
2076
+ [oauth](../README.md#oauth)
2077
+
2078
+ ### HTTP request headers
2079
+
2080
+ - **Content-Type**: Not defined
2081
+ - **Accept**: application/json
2082
+
2083
+
2084
+
2085
+ # **get_teachers_for_student**
2086
+ > TeachersResponse get_teachers_for_student(id, opts)
2087
+
2088
+ Retrieves all teachers for a student.
2089
+
2090
+ Returns the teachers for a student
2091
+
2092
+ ### Example
2093
+ ```ruby
2094
+ # load the gem
2095
+ require 'clever-ruby'
2096
+ # setup authorization
2097
+ Clever.configure do |config|
2098
+ # Configure OAuth2 access token for authorization: oauth
2099
+ config.access_token = 'YOUR ACCESS TOKEN'
2100
+ end
2101
+
2102
+ api_instance = Clever::DataApi.new
2103
+
2104
+ id = "id_example" # String |
2105
+
2106
+ opts = {
2107
+ limit: 56, # Integer |
2108
+ starting_after: "starting_after_example", # String |
2109
+ ending_before: "ending_before_example" # String |
2110
+ }
2111
+
2112
+ begin
2113
+ #Retrieves all teachers for a student.
2114
+ result = api_instance.get_teachers_for_student(id, opts)
2115
+ p result
2116
+ rescue Clever::ApiError => e
2117
+ puts "Exception when calling DataApi->get_teachers_for_student: #{e}"
2118
+ end
2119
+ ```
2120
+
2121
+ ### Parameters
2122
+
2123
+ Name | Type | Description | Notes
2124
+ ------------- | ------------- | ------------- | -------------
2125
+ **id** | **String**| |
2126
+ **limit** | **Integer**| | [optional]
2127
+ **starting_after** | **String**| | [optional]
2128
+ **ending_before** | **String**| | [optional]
2129
+
2130
+ ### Return type
2131
+
2132
+ [**TeachersResponse**](TeachersResponse.md)
2133
+
2134
+ ### Authorization
2135
+
2136
+ [oauth](../README.md#oauth)
2137
+
2138
+ ### HTTP request headers
2139
+
2140
+ - **Content-Type**: Not defined
2141
+ - **Accept**: application/json
2142
+
2143
+
2144
+