commonlit-clever-ruby 2.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (308) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +129 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +73 -0
  5. data/LICENSE +190 -0
  6. data/Makefile +10 -0
  7. data/README.md +265 -0
  8. data/Rakefile +8 -0
  9. data/clever-ruby.gemspec +46 -0
  10. data/docs/AdminName.md +9 -0
  11. data/docs/BadRequest.md +8 -0
  12. data/docs/Contact.md +17 -0
  13. data/docs/ContactObject.md +8 -0
  14. data/docs/ContactResponse.md +8 -0
  15. data/docs/ContactsCreated.md +11 -0
  16. data/docs/ContactsDeleted.md +11 -0
  17. data/docs/ContactsResponse.md +9 -0
  18. data/docs/ContactsUpdated.md +12 -0
  19. data/docs/Course.md +11 -0
  20. data/docs/CourseObject.md +8 -0
  21. data/docs/CourseResponse.md +8 -0
  22. data/docs/CoursesCreated.md +11 -0
  23. data/docs/CoursesDeleted.md +11 -0
  24. data/docs/CoursesResponse.md +9 -0
  25. data/docs/CoursesUpdated.md +12 -0
  26. data/docs/Credentials.md +8 -0
  27. data/docs/DataApi.md +2852 -0
  28. data/docs/District.md +21 -0
  29. data/docs/DistrictAdmin.md +12 -0
  30. data/docs/DistrictAdminObject.md +8 -0
  31. data/docs/DistrictAdminResponse.md +8 -0
  32. data/docs/DistrictAdminsResponse.md +9 -0
  33. data/docs/DistrictObject.md +8 -0
  34. data/docs/DistrictResponse.md +8 -0
  35. data/docs/DistrictadminsCreated.md +11 -0
  36. data/docs/DistrictadminsDeleted.md +11 -0
  37. data/docs/DistrictadminsUpdated.md +12 -0
  38. data/docs/DistrictsCreated.md +11 -0
  39. data/docs/DistrictsDeleted.md +11 -0
  40. data/docs/DistrictsResponse.md +9 -0
  41. data/docs/DistrictsUpdated.md +12 -0
  42. data/docs/Event.md +10 -0
  43. data/docs/EventResponse.md +8 -0
  44. data/docs/EventsApi.md +121 -0
  45. data/docs/EventsResponse.md +9 -0
  46. data/docs/InternalError.md +8 -0
  47. data/docs/Link.md +9 -0
  48. data/docs/Location.md +13 -0
  49. data/docs/Name.md +10 -0
  50. data/docs/NotFound.md +8 -0
  51. data/docs/Principal.md +9 -0
  52. data/docs/School.md +23 -0
  53. data/docs/SchoolAdmin.md +17 -0
  54. data/docs/SchoolAdminObject.md +8 -0
  55. data/docs/SchoolAdminResponse.md +8 -0
  56. data/docs/SchoolAdminsResponse.md +9 -0
  57. data/docs/SchoolEnrollment.md +10 -0
  58. data/docs/SchoolObject.md +8 -0
  59. data/docs/SchoolResponse.md +8 -0
  60. data/docs/SchooladminsCreated.md +11 -0
  61. data/docs/SchooladminsDeleted.md +11 -0
  62. data/docs/SchooladminsUpdated.md +12 -0
  63. data/docs/SchoolsCreated.md +11 -0
  64. data/docs/SchoolsDeleted.md +11 -0
  65. data/docs/SchoolsResponse.md +9 -0
  66. data/docs/SchoolsUpdated.md +12 -0
  67. data/docs/Section.md +24 -0
  68. data/docs/SectionObject.md +8 -0
  69. data/docs/SectionResponse.md +8 -0
  70. data/docs/SectionsCreated.md +11 -0
  71. data/docs/SectionsDeleted.md +11 -0
  72. data/docs/SectionsResponse.md +9 -0
  73. data/docs/SectionsUpdated.md +12 -0
  74. data/docs/Student.md +33 -0
  75. data/docs/StudentObject.md +8 -0
  76. data/docs/StudentResponse.md +8 -0
  77. data/docs/StudentsCreated.md +11 -0
  78. data/docs/StudentsDeleted.md +11 -0
  79. data/docs/StudentsResponse.md +9 -0
  80. data/docs/StudentsUpdated.md +12 -0
  81. data/docs/Teacher.md +21 -0
  82. data/docs/TeacherObject.md +8 -0
  83. data/docs/TeacherResponse.md +8 -0
  84. data/docs/TeachersCreated.md +11 -0
  85. data/docs/TeachersDeleted.md +11 -0
  86. data/docs/TeachersResponse.md +9 -0
  87. data/docs/TeachersUpdated.md +12 -0
  88. data/docs/Term.md +12 -0
  89. data/docs/TermObject.md +8 -0
  90. data/docs/TermResponse.md +8 -0
  91. data/docs/TermsCreated.md +11 -0
  92. data/docs/TermsDeleted.md +11 -0
  93. data/docs/TermsResponse.md +9 -0
  94. data/docs/TermsUpdated.md +12 -0
  95. data/git_push.sh +55 -0
  96. data/lib/clever-ruby.rb +124 -0
  97. data/lib/clever-ruby/api/data_api.rb +2798 -0
  98. data/lib/clever-ruby/api/events_api.rb +132 -0
  99. data/lib/clever-ruby/api_client.rb +414 -0
  100. data/lib/clever-ruby/api_error.rb +38 -0
  101. data/lib/clever-ruby/configuration.rb +209 -0
  102. data/lib/clever-ruby/models/admin_name.rb +193 -0
  103. data/lib/clever-ruby/models/bad_request.rb +184 -0
  104. data/lib/clever-ruby/models/contact.rb +325 -0
  105. data/lib/clever-ruby/models/contact_object.rb +184 -0
  106. data/lib/clever-ruby/models/contact_response.rb +184 -0
  107. data/lib/clever-ruby/models/contacts_created.rb +221 -0
  108. data/lib/clever-ruby/models/contacts_deleted.rb +221 -0
  109. data/lib/clever-ruby/models/contacts_response.rb +197 -0
  110. data/lib/clever-ruby/models/contacts_updated.rb +221 -0
  111. data/lib/clever-ruby/models/course.rb +211 -0
  112. data/lib/clever-ruby/models/course_object.rb +184 -0
  113. data/lib/clever-ruby/models/course_response.rb +184 -0
  114. data/lib/clever-ruby/models/courses_created.rb +221 -0
  115. data/lib/clever-ruby/models/courses_deleted.rb +221 -0
  116. data/lib/clever-ruby/models/courses_response.rb +197 -0
  117. data/lib/clever-ruby/models/courses_updated.rb +221 -0
  118. data/lib/clever-ruby/models/credentials.rb +184 -0
  119. data/lib/clever-ruby/models/district.rb +337 -0
  120. data/lib/clever-ruby/models/district_admin.rb +220 -0
  121. data/lib/clever-ruby/models/district_admin_object.rb +184 -0
  122. data/lib/clever-ruby/models/district_admin_response.rb +184 -0
  123. data/lib/clever-ruby/models/district_admins_response.rb +197 -0
  124. data/lib/clever-ruby/models/district_object.rb +184 -0
  125. data/lib/clever-ruby/models/district_response.rb +184 -0
  126. data/lib/clever-ruby/models/districtadmins_created.rb +221 -0
  127. data/lib/clever-ruby/models/districtadmins_deleted.rb +221 -0
  128. data/lib/clever-ruby/models/districtadmins_updated.rb +221 -0
  129. data/lib/clever-ruby/models/districts_created.rb +221 -0
  130. data/lib/clever-ruby/models/districts_deleted.rb +221 -0
  131. data/lib/clever-ruby/models/districts_response.rb +197 -0
  132. data/lib/clever-ruby/models/districts_updated.rb +221 -0
  133. data/lib/clever-ruby/models/event.rb +207 -0
  134. data/lib/clever-ruby/models/event_response.rb +184 -0
  135. data/lib/clever-ruby/models/events_response.rb +197 -0
  136. data/lib/clever-ruby/models/internal_error.rb +184 -0
  137. data/lib/clever-ruby/models/link.rb +227 -0
  138. data/lib/clever-ruby/models/location.rb +229 -0
  139. data/lib/clever-ruby/models/name.rb +202 -0
  140. data/lib/clever-ruby/models/not_found.rb +184 -0
  141. data/lib/clever-ruby/models/principal.rb +193 -0
  142. data/lib/clever-ruby/models/school.rb +365 -0
  143. data/lib/clever-ruby/models/school_admin.rb +267 -0
  144. data/lib/clever-ruby/models/school_admin_object.rb +184 -0
  145. data/lib/clever-ruby/models/school_admin_response.rb +184 -0
  146. data/lib/clever-ruby/models/school_admins_response.rb +197 -0
  147. data/lib/clever-ruby/models/school_enrollment.rb +202 -0
  148. data/lib/clever-ruby/models/school_object.rb +184 -0
  149. data/lib/clever-ruby/models/school_response.rb +184 -0
  150. data/lib/clever-ruby/models/schooladmins_created.rb +221 -0
  151. data/lib/clever-ruby/models/schooladmins_deleted.rb +221 -0
  152. data/lib/clever-ruby/models/schooladmins_updated.rb +221 -0
  153. data/lib/clever-ruby/models/schools_created.rb +221 -0
  154. data/lib/clever-ruby/models/schools_deleted.rb +221 -0
  155. data/lib/clever-ruby/models/schools_response.rb +197 -0
  156. data/lib/clever-ruby/models/schools_updated.rb +221 -0
  157. data/lib/clever-ruby/models/section.rb +378 -0
  158. data/lib/clever-ruby/models/section_object.rb +184 -0
  159. data/lib/clever-ruby/models/section_response.rb +184 -0
  160. data/lib/clever-ruby/models/sections_created.rb +221 -0
  161. data/lib/clever-ruby/models/sections_deleted.rb +221 -0
  162. data/lib/clever-ruby/models/sections_response.rb +197 -0
  163. data/lib/clever-ruby/models/sections_updated.rb +221 -0
  164. data/lib/clever-ruby/models/student.rb +507 -0
  165. data/lib/clever-ruby/models/student_object.rb +184 -0
  166. data/lib/clever-ruby/models/student_response.rb +184 -0
  167. data/lib/clever-ruby/models/students_created.rb +221 -0
  168. data/lib/clever-ruby/models/students_deleted.rb +221 -0
  169. data/lib/clever-ruby/models/students_response.rb +197 -0
  170. data/lib/clever-ruby/models/students_updated.rb +221 -0
  171. data/lib/clever-ruby/models/teacher.rb +303 -0
  172. data/lib/clever-ruby/models/teacher_object.rb +184 -0
  173. data/lib/clever-ruby/models/teacher_response.rb +184 -0
  174. data/lib/clever-ruby/models/teachers_created.rb +221 -0
  175. data/lib/clever-ruby/models/teachers_deleted.rb +221 -0
  176. data/lib/clever-ruby/models/teachers_response.rb +197 -0
  177. data/lib/clever-ruby/models/teachers_updated.rb +221 -0
  178. data/lib/clever-ruby/models/term.rb +220 -0
  179. data/lib/clever-ruby/models/term_object.rb +184 -0
  180. data/lib/clever-ruby/models/term_response.rb +184 -0
  181. data/lib/clever-ruby/models/terms_created.rb +221 -0
  182. data/lib/clever-ruby/models/terms_deleted.rb +221 -0
  183. data/lib/clever-ruby/models/terms_response.rb +197 -0
  184. data/lib/clever-ruby/models/terms_updated.rb +221 -0
  185. data/lib/clever-ruby/version.rb +15 -0
  186. data/override/README-extension.md +31 -0
  187. data/override/api_client.rb +414 -0
  188. data/override/models/contacts_created.rb +221 -0
  189. data/override/models/contacts_deleted.rb +221 -0
  190. data/override/models/contacts_updated.rb +221 -0
  191. data/override/models/courses_created.rb +221 -0
  192. data/override/models/courses_deleted.rb +221 -0
  193. data/override/models/courses_updated.rb +221 -0
  194. data/override/models/districtadmins_created.rb +221 -0
  195. data/override/models/districtadmins_deleted.rb +221 -0
  196. data/override/models/districtadmins_updated.rb +221 -0
  197. data/override/models/districts_created.rb +221 -0
  198. data/override/models/districts_deleted.rb +221 -0
  199. data/override/models/districts_updated.rb +221 -0
  200. data/override/models/schooladmins_created.rb +221 -0
  201. data/override/models/schooladmins_deleted.rb +221 -0
  202. data/override/models/schooladmins_updated.rb +221 -0
  203. data/override/models/schools_created.rb +221 -0
  204. data/override/models/schools_deleted.rb +221 -0
  205. data/override/models/schools_updated.rb +221 -0
  206. data/override/models/sections_created.rb +221 -0
  207. data/override/models/sections_deleted.rb +221 -0
  208. data/override/models/sections_updated.rb +221 -0
  209. data/override/models/students_created.rb +221 -0
  210. data/override/models/students_deleted.rb +221 -0
  211. data/override/models/students_updated.rb +221 -0
  212. data/override/models/teachers_created.rb +221 -0
  213. data/override/models/teachers_deleted.rb +221 -0
  214. data/override/models/teachers_updated.rb +221 -0
  215. data/override/models/terms_created.rb +221 -0
  216. data/override/models/terms_deleted.rb +221 -0
  217. data/override/models/terms_updated.rb +221 -0
  218. data/override/override.sh +27 -0
  219. data/sample/sample.rb +16 -0
  220. data/spec/api/data_api_spec.rb +671 -0
  221. data/spec/api/events_api_spec.rb +61 -0
  222. data/spec/api_client_spec.rb +226 -0
  223. data/spec/configuration_spec.rb +42 -0
  224. data/spec/events.json +227 -0
  225. data/spec/models/bad_request_spec.rb +41 -0
  226. data/spec/models/contact_object_spec.rb +41 -0
  227. data/spec/models/contact_response_spec.rb +41 -0
  228. data/spec/models/contact_spec.rb +107 -0
  229. data/spec/models/contacts_created_spec.rb +59 -0
  230. data/spec/models/contacts_deleted_spec.rb +59 -0
  231. data/spec/models/contacts_response_spec.rb +41 -0
  232. data/spec/models/contacts_updated_spec.rb +65 -0
  233. data/spec/models/course_object_spec.rb +41 -0
  234. data/spec/models/course_response_spec.rb +41 -0
  235. data/spec/models/course_spec.rb +59 -0
  236. data/spec/models/courses_created_spec.rb +59 -0
  237. data/spec/models/courses_deleted_spec.rb +59 -0
  238. data/spec/models/courses_response_spec.rb +41 -0
  239. data/spec/models/courses_updated_spec.rb +65 -0
  240. data/spec/models/credentials_spec.rb +41 -0
  241. data/spec/models/district_admin_object_spec.rb +41 -0
  242. data/spec/models/district_admin_response_spec.rb +41 -0
  243. data/spec/models/district_admin_spec.rb +65 -0
  244. data/spec/models/district_admins_response_spec.rb +41 -0
  245. data/spec/models/district_object_spec.rb +41 -0
  246. data/spec/models/district_response_spec.rb +41 -0
  247. data/spec/models/district_spec.rb +123 -0
  248. data/spec/models/districtadmins_created_spec.rb +59 -0
  249. data/spec/models/districtadmins_deleted_spec.rb +59 -0
  250. data/spec/models/districtadmins_updated_spec.rb +65 -0
  251. data/spec/models/districts_created_spec.rb +59 -0
  252. data/spec/models/districts_deleted_spec.rb +59 -0
  253. data/spec/models/districts_response_spec.rb +41 -0
  254. data/spec/models/districts_updated_spec.rb +65 -0
  255. data/spec/models/event_response_spec.rb +41 -0
  256. data/spec/models/event_spec.rb +53 -0
  257. data/spec/models/events_response_spec.rb +41 -0
  258. data/spec/models/internal_error_spec.rb +41 -0
  259. data/spec/models/location_spec.rb +71 -0
  260. data/spec/models/name_spec.rb +53 -0
  261. data/spec/models/not_found_spec.rb +41 -0
  262. data/spec/models/principal_spec.rb +47 -0
  263. data/spec/models/school_admin_object_spec.rb +41 -0
  264. data/spec/models/school_admin_response_spec.rb +41 -0
  265. data/spec/models/school_admin_spec.rb +95 -0
  266. data/spec/models/school_admins_response_spec.rb +41 -0
  267. data/spec/models/school_enrollment_spec.rb +53 -0
  268. data/spec/models/school_object_spec.rb +41 -0
  269. data/spec/models/school_response_spec.rb +41 -0
  270. data/spec/models/school_spec.rb +139 -0
  271. data/spec/models/schooladmins_created_spec.rb +59 -0
  272. data/spec/models/schooladmins_deleted_spec.rb +59 -0
  273. data/spec/models/schooladmins_updated_spec.rb +65 -0
  274. data/spec/models/schools_created_spec.rb +59 -0
  275. data/spec/models/schools_deleted_spec.rb +59 -0
  276. data/spec/models/schools_response_spec.rb +41 -0
  277. data/spec/models/schools_updated_spec.rb +65 -0
  278. data/spec/models/section_object_spec.rb +41 -0
  279. data/spec/models/section_response_spec.rb +41 -0
  280. data/spec/models/section_spec.rb +145 -0
  281. data/spec/models/sections_created_spec.rb +59 -0
  282. data/spec/models/sections_deleted_spec.rb +59 -0
  283. data/spec/models/sections_response_spec.rb +41 -0
  284. data/spec/models/sections_updated_spec.rb +65 -0
  285. data/spec/models/student_object_spec.rb +41 -0
  286. data/spec/models/student_response_spec.rb +41 -0
  287. data/spec/models/student_spec.rb +215 -0
  288. data/spec/models/students_created_spec.rb +59 -0
  289. data/spec/models/students_deleted_spec.rb +59 -0
  290. data/spec/models/students_response_spec.rb +41 -0
  291. data/spec/models/students_updated_spec.rb +65 -0
  292. data/spec/models/teacher_object_spec.rb +41 -0
  293. data/spec/models/teacher_response_spec.rb +41 -0
  294. data/spec/models/teacher_spec.rb +119 -0
  295. data/spec/models/teachers_created_spec.rb +59 -0
  296. data/spec/models/teachers_deleted_spec.rb +59 -0
  297. data/spec/models/teachers_response_spec.rb +41 -0
  298. data/spec/models/teachers_updated_spec.rb +65 -0
  299. data/spec/models/term_object_spec.rb +41 -0
  300. data/spec/models/term_response_spec.rb +41 -0
  301. data/spec/models/term_spec.rb +65 -0
  302. data/spec/models/terms_created_spec.rb +59 -0
  303. data/spec/models/terms_deleted_spec.rb +59 -0
  304. data/spec/models/terms_response_spec.rb +41 -0
  305. data/spec/models/terms_updated_spec.rb +65 -0
  306. data/spec/spec_helper.rb +103 -0
  307. data/tags +1681 -0
  308. metadata +636 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d1196bfc6275e70a148487e37084216259989a4a4b9294247a800a691ee724f5
4
+ data.tar.gz: 07e59fb606a345d8c6e2ffd973030ed8f91bd7bb5e5aa80317d74b0752c8c9fe
5
+ SHA512:
6
+ metadata.gz: 9e9b62e58d3e500db47a85a6a9709723657972cd50c140618a5956c4c8310e4776a1a6227d9fa844d29393381e2434af527b02c322801ab82ea633363bf08e31
7
+ data.tar.gz: 89d3db67beb3932d58ddedc3ffe6e344876fbdb9257339051ac6c4e421ee9d0b0ee0889c17928a1c4661bc91e5031139406fa96a8f08f5416110646ad4288e5a
@@ -0,0 +1,129 @@
1
+ ## 2.1.0 (2019-09-20)
2
+
3
+ * Update to use API v2.1
4
+
5
+ ## 2.0.2 (2019-01-03)
6
+
7
+ * Relax json dependency
8
+
9
+ ## 2.0.1 (2018-05-15)
10
+
11
+ * Change students home_language 'Telegu' to 'Telugu'
12
+
13
+ ## 2.0.0 (2017-11-03)
14
+
15
+ * Supports API version 2.0
16
+
17
+ ## 1.2.4 (2017-08-24)
18
+
19
+ * Revert unnecessary json dependency upgrade introduced in 1.2.2
20
+ * Lock gem versions to allow Ruby 1.9 usage again
21
+
22
+ ## 1.2.3 (2017-08-04)
23
+
24
+ * Fix DistrictStatus valid states
25
+
26
+ ## 1.2.2 (2017-07-17)
27
+
28
+ * Fix Students.Created events to pull in ID and Type
29
+ * Fix /students/ID/contacts endpoint to read contacts correctly
30
+
31
+ ## 1.2.1 (2017-06-27)
32
+
33
+ * Fixed events models
34
+
35
+ ## 1.2.0 (2017-06-09)
36
+
37
+ * Added new fields for students and student contacts
38
+ * Fixed district status endpoint
39
+
40
+ ## 1.1.0 (2017-05-02)
41
+
42
+ * Added support for enums
43
+ * Fixed typo in district_admin.launch_date
44
+
45
+ ## 1.0.0 (2017-04-05)
46
+
47
+ * New auto-generated client library from v1.2
48
+
49
+ ## 0.14.0 (2017-03-31)
50
+
51
+ * Add District Admins
52
+
53
+ ## 0.13.2 (2016-02-08)
54
+
55
+ * Reduce constraint on multi_json
56
+
57
+ ## 0.13.1 (2015-10-19)
58
+
59
+ * Fix bug where school_admins used incorrect event type
60
+
61
+ ## 0.13.0 (2015-10-05)
62
+
63
+ * Add support for school admins
64
+
65
+ ## 0.12.0 (2015-09-28)
66
+
67
+ * Remove inflector dependency
68
+
69
+ ## 0.11.1 (2015-09-28)
70
+
71
+ * Fix APIError throwing a TypeError when API requests fail
72
+
73
+ ## 0.11.0 (2015-09-28)
74
+
75
+ * Allow timeout and open_timeout configurable
76
+ * Allow nested resources more than 1 level deep
77
+
78
+ ## 0.10.2 (2015-09-28)
79
+
80
+ * Remove duplicated code, test against Ruby 2.0.0
81
+
82
+ ## 0.10.1 (2014-10-09)
83
+
84
+ * Update activesupport to 4.2.1
85
+
86
+ ## 0.10.0 (2014-10-09)
87
+
88
+ * Add tracking headers to all api requeusts
89
+
90
+ ## 0.9.0 (2014-10-02)
91
+
92
+ * Update district to accept optional auth token
93
+
94
+ ## 0.8.0 (2014-09-12)
95
+
96
+ * Add last method to lists of results for all resources
97
+
98
+ ## 0.7.0 (2014-09-12)
99
+
100
+ * Make nested resources support full queries, including find and count
101
+ * Make tests more robust to data changes
102
+
103
+ ## 0.6.2 (2014-09-12)
104
+
105
+ * Update dependencies
106
+ * Add activesupport as dep
107
+ * Refactor tests
108
+
109
+ ## 0.6.1 (2014-09-10)
110
+
111
+ * Add YARD documentation
112
+ * Remove unused Clever::Student.photo method
113
+
114
+ ## 0.6.0 (2014-09-10)
115
+
116
+ * Add ActiveRecord-style find and count methods to all APIResources (#37)
117
+
118
+ ## 0.5.0 (2014-09-09)
119
+
120
+ * Handle pagination through rel links, not manual numeric pagination (#36)
121
+
122
+ ## 0.4.0 (2014-09-05)
123
+
124
+ * Linked resources for all API resources (#34)
125
+
126
+ ## 0.3.0 (2014-02-28)
127
+
128
+ * Support for token auth (#17)
129
+ * Move to clever.com (#19)
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.3.3'
7
+ end
@@ -0,0 +1,73 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ clever-ruby (2.1.0)
5
+ json (~> 2.1, >= 2.1.0)
6
+ typhoeus (~> 1.0, >= 1.0.1)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ addressable (2.4.0)
12
+ autotest (5.0.0)
13
+ minitest-autotest (~> 1.0)
14
+ autotest-fsevent (0.2.17)
15
+ sys-uname
16
+ autotest-growl (0.2.16)
17
+ autotest-rails-pure (4.1.2)
18
+ crack (0.4.3)
19
+ safe_yaml (~> 1.0.0)
20
+ diff-lcs (1.3)
21
+ ethon (0.12.0)
22
+ ffi (>= 1.3.0)
23
+ ffi (1.13.1)
24
+ hashdiff (0.3.8)
25
+ json (2.3.0)
26
+ minitest (5.12.0)
27
+ minitest-autotest (1.1.1)
28
+ minitest-server (~> 1.0)
29
+ path_expander (~> 1.0)
30
+ minitest-server (1.0.6)
31
+ minitest (~> 5.0)
32
+ path_expander (1.1.0)
33
+ rake (12.3.3)
34
+ rspec (3.9.0)
35
+ rspec-core (~> 3.9.0)
36
+ rspec-expectations (~> 3.9.0)
37
+ rspec-mocks (~> 3.9.0)
38
+ rspec-core (3.9.2)
39
+ rspec-support (~> 3.9.3)
40
+ rspec-expectations (3.9.2)
41
+ diff-lcs (>= 1.2.0, < 2.0)
42
+ rspec-support (~> 3.9.0)
43
+ rspec-mocks (3.9.1)
44
+ diff-lcs (>= 1.2.0, < 2.0)
45
+ rspec-support (~> 3.9.0)
46
+ rspec-support (3.9.3)
47
+ safe_yaml (1.0.5)
48
+ sys-uname (1.2.1)
49
+ ffi (>= 1.0.0)
50
+ typhoeus (1.4.0)
51
+ ethon (>= 0.9.0)
52
+ vcr (5.1.0)
53
+ webmock (2.3.2)
54
+ addressable (>= 2.3.6)
55
+ crack (>= 0.3.2)
56
+ hashdiff
57
+
58
+ PLATFORMS
59
+ ruby
60
+
61
+ DEPENDENCIES
62
+ autotest (~> 5.0, >= 4.4.6)
63
+ autotest-fsevent (~> 0.2, >= 0.2.12)
64
+ autotest-growl (~> 0.2, >= 0.2.16)
65
+ autotest-rails-pure (~> 4.1, >= 4.1.2)
66
+ clever-ruby!
67
+ rake (~> 12.3.3)
68
+ rspec (~> 3.6, >= 3.6.0)
69
+ vcr (~> 5.1, >= 3.0.1)
70
+ webmock (~> 2.3, >= 1.24.3)
71
+
72
+ BUNDLED WITH
73
+ 1.15.3
data/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2014 Clever, Inc.
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,10 @@
1
+ .PHONY: all test build run
2
+ SHELL := /bin/bash
3
+
4
+ all: test build
5
+
6
+ test:
7
+ bundle install && bundle exec rake spec
8
+
9
+ build:
10
+ ./override/override.sh
@@ -0,0 +1,265 @@
1
+ # clever-ruby
2
+
3
+ Clever - the Ruby gem for the Clever API
4
+
5
+ The Clever API
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 2.1.0
10
+ - Package version: 2.1.1
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build clever-ruby.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./clever-ruby-2.1.1.gem
27
+ ```
28
+ (for development, run `gem install --dev ./clever-ruby-2.1.1.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'clever-ruby', '~> 2.1.1'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'clever-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'clever-ruby'
56
+
57
+ # Setup authorization
58
+ Clever.configure do |config|
59
+ # Configure OAuth2 access token for authorization: oauth
60
+ config.access_token = 'YOUR ACCESS TOKEN'
61
+ end
62
+
63
+ api_instance = Clever::DataApi.new
64
+
65
+ id = 'id_example' # String |
66
+
67
+
68
+ begin
69
+ result = api_instance.get_contact(id)
70
+ p result
71
+ rescue Clever::ApiError => e
72
+ puts "Exception when calling DataApi->get_contact: #{e}"
73
+ end
74
+
75
+ ```
76
+
77
+ ## Documentation for API Endpoints
78
+
79
+ All URIs are relative to *https://api.clever.com/v2.1*
80
+
81
+ Class | Method | HTTP request | Description
82
+ ------------ | ------------- | ------------- | -------------
83
+ *Clever::DataApi* | [**get_contact**](docs/DataApi.md#get_contact) | **GET** /contacts/{id} |
84
+ *Clever::DataApi* | [**get_contacts**](docs/DataApi.md#get_contacts) | **GET** /contacts |
85
+ *Clever::DataApi* | [**get_contacts_for_student**](docs/DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
86
+ *Clever::DataApi* | [**get_course**](docs/DataApi.md#get_course) | **GET** /courses/{id} |
87
+ *Clever::DataApi* | [**get_course_for_section**](docs/DataApi.md#get_course_for_section) | **GET** /sections/{id}/course |
88
+ *Clever::DataApi* | [**get_courses**](docs/DataApi.md#get_courses) | **GET** /courses |
89
+ *Clever::DataApi* | [**get_district**](docs/DataApi.md#get_district) | **GET** /districts/{id} |
90
+ *Clever::DataApi* | [**get_district_admin**](docs/DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
91
+ *Clever::DataApi* | [**get_district_admins**](docs/DataApi.md#get_district_admins) | **GET** /district_admins |
92
+ *Clever::DataApi* | [**get_district_for_contact**](docs/DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
93
+ *Clever::DataApi* | [**get_district_for_course**](docs/DataApi.md#get_district_for_course) | **GET** /courses/{id}/district |
94
+ *Clever::DataApi* | [**get_district_for_district_admin**](docs/DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
95
+ *Clever::DataApi* | [**get_district_for_school**](docs/DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
96
+ *Clever::DataApi* | [**get_district_for_school_admin**](docs/DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
97
+ *Clever::DataApi* | [**get_district_for_section**](docs/DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
98
+ *Clever::DataApi* | [**get_district_for_student**](docs/DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
99
+ *Clever::DataApi* | [**get_district_for_teacher**](docs/DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
100
+ *Clever::DataApi* | [**get_district_for_term**](docs/DataApi.md#get_district_for_term) | **GET** /terms/{id}/district |
101
+ *Clever::DataApi* | [**get_districts**](docs/DataApi.md#get_districts) | **GET** /districts |
102
+ *Clever::DataApi* | [**get_school**](docs/DataApi.md#get_school) | **GET** /schools/{id} |
103
+ *Clever::DataApi* | [**get_school_admin**](docs/DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
104
+ *Clever::DataApi* | [**get_school_admins**](docs/DataApi.md#get_school_admins) | **GET** /school_admins |
105
+ *Clever::DataApi* | [**get_school_for_section**](docs/DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
106
+ *Clever::DataApi* | [**get_school_for_student**](docs/DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
107
+ *Clever::DataApi* | [**get_school_for_teacher**](docs/DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
108
+ *Clever::DataApi* | [**get_schools**](docs/DataApi.md#get_schools) | **GET** /schools |
109
+ *Clever::DataApi* | [**get_schools_for_school_admin**](docs/DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
110
+ *Clever::DataApi* | [**get_schools_for_student**](docs/DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
111
+ *Clever::DataApi* | [**get_schools_for_teacher**](docs/DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
112
+ *Clever::DataApi* | [**get_section**](docs/DataApi.md#get_section) | **GET** /sections/{id} |
113
+ *Clever::DataApi* | [**get_sections**](docs/DataApi.md#get_sections) | **GET** /sections |
114
+ *Clever::DataApi* | [**get_sections_for_course**](docs/DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
115
+ *Clever::DataApi* | [**get_sections_for_school**](docs/DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
116
+ *Clever::DataApi* | [**get_sections_for_student**](docs/DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
117
+ *Clever::DataApi* | [**get_sections_for_teacher**](docs/DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
118
+ *Clever::DataApi* | [**get_sections_for_term**](docs/DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
119
+ *Clever::DataApi* | [**get_student**](docs/DataApi.md#get_student) | **GET** /students/{id} |
120
+ *Clever::DataApi* | [**get_students**](docs/DataApi.md#get_students) | **GET** /students |
121
+ *Clever::DataApi* | [**get_students_for_contact**](docs/DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
122
+ *Clever::DataApi* | [**get_students_for_school**](docs/DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
123
+ *Clever::DataApi* | [**get_students_for_section**](docs/DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
124
+ *Clever::DataApi* | [**get_students_for_teacher**](docs/DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
125
+ *Clever::DataApi* | [**get_teacher**](docs/DataApi.md#get_teacher) | **GET** /teachers/{id} |
126
+ *Clever::DataApi* | [**get_teacher_for_section**](docs/DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
127
+ *Clever::DataApi* | [**get_teachers**](docs/DataApi.md#get_teachers) | **GET** /teachers |
128
+ *Clever::DataApi* | [**get_teachers_for_school**](docs/DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
129
+ *Clever::DataApi* | [**get_teachers_for_section**](docs/DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
130
+ *Clever::DataApi* | [**get_teachers_for_student**](docs/DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
131
+ *Clever::DataApi* | [**get_term**](docs/DataApi.md#get_term) | **GET** /terms/{id} |
132
+ *Clever::DataApi* | [**get_term_for_section**](docs/DataApi.md#get_term_for_section) | **GET** /sections/{id}/term |
133
+ *Clever::DataApi* | [**get_terms**](docs/DataApi.md#get_terms) | **GET** /terms |
134
+ *Clever::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} |
135
+ *Clever::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events |
136
+
137
+
138
+ ## Documentation for Models
139
+
140
+ - [Clever::AdminName](docs/AdminName.md)
141
+ - [Clever::BadRequest](docs/BadRequest.md)
142
+ - [Clever::Contact](docs/Contact.md)
143
+ - [Clever::ContactObject](docs/ContactObject.md)
144
+ - [Clever::ContactResponse](docs/ContactResponse.md)
145
+ - [Clever::ContactsCreated](docs/ContactsCreated.md)
146
+ - [Clever::ContactsDeleted](docs/ContactsDeleted.md)
147
+ - [Clever::ContactsResponse](docs/ContactsResponse.md)
148
+ - [Clever::ContactsUpdated](docs/ContactsUpdated.md)
149
+ - [Clever::Course](docs/Course.md)
150
+ - [Clever::CourseObject](docs/CourseObject.md)
151
+ - [Clever::CourseResponse](docs/CourseResponse.md)
152
+ - [Clever::CoursesCreated](docs/CoursesCreated.md)
153
+ - [Clever::CoursesDeleted](docs/CoursesDeleted.md)
154
+ - [Clever::CoursesResponse](docs/CoursesResponse.md)
155
+ - [Clever::CoursesUpdated](docs/CoursesUpdated.md)
156
+ - [Clever::Credentials](docs/Credentials.md)
157
+ - [Clever::District](docs/District.md)
158
+ - [Clever::DistrictAdmin](docs/DistrictAdmin.md)
159
+ - [Clever::DistrictAdminObject](docs/DistrictAdminObject.md)
160
+ - [Clever::DistrictAdminResponse](docs/DistrictAdminResponse.md)
161
+ - [Clever::DistrictAdminsResponse](docs/DistrictAdminsResponse.md)
162
+ - [Clever::DistrictObject](docs/DistrictObject.md)
163
+ - [Clever::DistrictResponse](docs/DistrictResponse.md)
164
+ - [Clever::DistrictadminsCreated](docs/DistrictadminsCreated.md)
165
+ - [Clever::DistrictadminsDeleted](docs/DistrictadminsDeleted.md)
166
+ - [Clever::DistrictadminsUpdated](docs/DistrictadminsUpdated.md)
167
+ - [Clever::DistrictsCreated](docs/DistrictsCreated.md)
168
+ - [Clever::DistrictsDeleted](docs/DistrictsDeleted.md)
169
+ - [Clever::DistrictsResponse](docs/DistrictsResponse.md)
170
+ - [Clever::DistrictsUpdated](docs/DistrictsUpdated.md)
171
+ - [Clever::Event](docs/Event.md)
172
+ - [Clever::EventResponse](docs/EventResponse.md)
173
+ - [Clever::EventsResponse](docs/EventsResponse.md)
174
+ - [Clever::InternalError](docs/InternalError.md)
175
+ - [Clever::Link](docs/Link.md)
176
+ - [Clever::Location](docs/Location.md)
177
+ - [Clever::Name](docs/Name.md)
178
+ - [Clever::NotFound](docs/NotFound.md)
179
+ - [Clever::Principal](docs/Principal.md)
180
+ - [Clever::School](docs/School.md)
181
+ - [Clever::SchoolAdmin](docs/SchoolAdmin.md)
182
+ - [Clever::SchoolAdminObject](docs/SchoolAdminObject.md)
183
+ - [Clever::SchoolAdminResponse](docs/SchoolAdminResponse.md)
184
+ - [Clever::SchoolAdminsResponse](docs/SchoolAdminsResponse.md)
185
+ - [Clever::SchoolEnrollment](docs/SchoolEnrollment.md)
186
+ - [Clever::SchoolObject](docs/SchoolObject.md)
187
+ - [Clever::SchoolResponse](docs/SchoolResponse.md)
188
+ - [Clever::SchooladminsCreated](docs/SchooladminsCreated.md)
189
+ - [Clever::SchooladminsDeleted](docs/SchooladminsDeleted.md)
190
+ - [Clever::SchooladminsUpdated](docs/SchooladminsUpdated.md)
191
+ - [Clever::SchoolsCreated](docs/SchoolsCreated.md)
192
+ - [Clever::SchoolsDeleted](docs/SchoolsDeleted.md)
193
+ - [Clever::SchoolsResponse](docs/SchoolsResponse.md)
194
+ - [Clever::SchoolsUpdated](docs/SchoolsUpdated.md)
195
+ - [Clever::Section](docs/Section.md)
196
+ - [Clever::SectionObject](docs/SectionObject.md)
197
+ - [Clever::SectionResponse](docs/SectionResponse.md)
198
+ - [Clever::SectionsCreated](docs/SectionsCreated.md)
199
+ - [Clever::SectionsDeleted](docs/SectionsDeleted.md)
200
+ - [Clever::SectionsResponse](docs/SectionsResponse.md)
201
+ - [Clever::SectionsUpdated](docs/SectionsUpdated.md)
202
+ - [Clever::Student](docs/Student.md)
203
+ - [Clever::StudentObject](docs/StudentObject.md)
204
+ - [Clever::StudentResponse](docs/StudentResponse.md)
205
+ - [Clever::StudentsCreated](docs/StudentsCreated.md)
206
+ - [Clever::StudentsDeleted](docs/StudentsDeleted.md)
207
+ - [Clever::StudentsResponse](docs/StudentsResponse.md)
208
+ - [Clever::StudentsUpdated](docs/StudentsUpdated.md)
209
+ - [Clever::Teacher](docs/Teacher.md)
210
+ - [Clever::TeacherObject](docs/TeacherObject.md)
211
+ - [Clever::TeacherResponse](docs/TeacherResponse.md)
212
+ - [Clever::TeachersCreated](docs/TeachersCreated.md)
213
+ - [Clever::TeachersDeleted](docs/TeachersDeleted.md)
214
+ - [Clever::TeachersResponse](docs/TeachersResponse.md)
215
+ - [Clever::TeachersUpdated](docs/TeachersUpdated.md)
216
+ - [Clever::Term](docs/Term.md)
217
+ - [Clever::TermObject](docs/TermObject.md)
218
+ - [Clever::TermResponse](docs/TermResponse.md)
219
+ - [Clever::TermsCreated](docs/TermsCreated.md)
220
+ - [Clever::TermsDeleted](docs/TermsDeleted.md)
221
+ - [Clever::TermsResponse](docs/TermsResponse.md)
222
+ - [Clever::TermsUpdated](docs/TermsUpdated.md)
223
+
224
+
225
+ ## Documentation for Authorization
226
+
227
+
228
+ ### oauth
229
+
230
+ - **Type**: OAuth
231
+ - **Flow**: accessCode
232
+ - **Authorization URL**: https://clever.com/oauth/authorize
233
+ - **Scopes**: N/A
234
+
235
+ ## Previous Versions
236
+
237
+ The current client support v2.0 of the API. For v1.2 please use:
238
+
239
+ - https://rubygems.org/gems/clever-ruby/versions/1.2.4
240
+ - https://github.com/Clever/clever-ruby/tree/v1.2.4
241
+
242
+
243
+ ## Updating the Library
244
+
245
+ 1. Git clone swagger-codegen (https://github.com/swagger-api/swagger-codegen)
246
+
247
+ 2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
248
+
249
+ 3. Run this command in the swagger-codegen repo
250
+ ```
251
+ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v2.0-client.yml -l ruby -o $PATH_TO_THIS_REPO --additional-properties gemVersion=$VERSION
252
+ ```
253
+
254
+ 4. Run `make build` to copy over the override files
255
+
256
+
257
+ ## Publishing
258
+
259
+ Signup to rubygems.org if you don't already have an account, and ask one of the gem [owners](https://rubygems.org/gems/clever-ruby) to add you as an owner. You'll be prompted to log in from the command line when you push the gem, if you aren't already logged in.
260
+
261
+ To add a new owner, you need to be an owner, then run this command: `gem owner clever-ruby -a <emailaddress>`
262
+
263
+ 1. Update `CHANGELOG.md`
264
+ 1. `gem build clever-ruby.gemspec`
265
+ 1. `gem push clever-ruby-X.Y.Z.gem`