clever-ruby 0.14.0 → 1.0.0

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