commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +37 -29
  4. data/README.md +994 -61
  5. data/clever-ruby.gemspec +6 -13
  6. data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
  7. data/commonlit-clever-ruby-2.1.6.beta2.gem +0 -0
  8. data/docs/AdminName.md +0 -1
  9. data/docs/BadRequest.md +0 -1
  10. data/docs/Contact.md +1 -2
  11. data/docs/ContactObject.md +0 -1
  12. data/docs/ContactResponse.md +0 -1
  13. data/docs/ContactsCreated.md +2 -3
  14. data/docs/ContactsDeleted.md +2 -3
  15. data/docs/ContactsResponse.md +0 -1
  16. data/docs/ContactsUpdated.md +2 -3
  17. data/docs/Course.md +1 -2
  18. data/docs/CourseObject.md +0 -1
  19. data/docs/CourseResponse.md +0 -1
  20. data/docs/CoursesCreated.md +2 -3
  21. data/docs/CoursesDeleted.md +2 -3
  22. data/docs/CoursesResponse.md +0 -1
  23. data/docs/CoursesUpdated.md +2 -3
  24. data/docs/Credentials.md +0 -1
  25. data/docs/DataApi.md +2784 -0
  26. data/docs/District.md +9 -10
  27. data/docs/DistrictAdmin.md +2 -3
  28. data/docs/DistrictAdminObject.md +0 -1
  29. data/docs/DistrictAdminResponse.md +0 -1
  30. data/docs/DistrictAdminsResponse.md +0 -1
  31. data/docs/DistrictObject.md +0 -1
  32. data/docs/DistrictResponse.md +0 -1
  33. data/docs/DistrictadminsCreated.md +2 -3
  34. data/docs/DistrictadminsDeleted.md +2 -3
  35. data/docs/DistrictadminsUpdated.md +2 -3
  36. data/docs/DistrictsCreated.md +2 -3
  37. data/docs/DistrictsDeleted.md +2 -3
  38. data/docs/DistrictsResponse.md +0 -1
  39. data/docs/DistrictsUpdated.md +2 -3
  40. data/docs/Event.md +2 -3
  41. data/docs/EventResponse.md +0 -1
  42. data/docs/EventsApi.md +1 -4
  43. data/docs/EventsResponse.md +0 -1
  44. data/docs/InternalError.md +0 -1
  45. data/docs/Link.md +0 -1
  46. data/docs/Location.md +2 -3
  47. data/docs/Name.md +1 -2
  48. data/docs/NotFound.md +0 -1
  49. data/docs/Principal.md +1 -2
  50. data/docs/School.md +3 -4
  51. data/docs/SchoolAdmin.md +3 -4
  52. data/docs/SchoolAdminObject.md +0 -1
  53. data/docs/SchoolAdminResponse.md +0 -1
  54. data/docs/SchoolAdminsResponse.md +0 -1
  55. data/docs/SchoolEnrollment.md +1 -2
  56. data/docs/SchoolObject.md +0 -1
  57. data/docs/SchoolResponse.md +0 -1
  58. data/docs/SchooladminsCreated.md +2 -3
  59. data/docs/SchooladminsDeleted.md +2 -3
  60. data/docs/SchooladminsUpdated.md +2 -3
  61. data/docs/SchoolsCreated.md +2 -3
  62. data/docs/SchoolsDeleted.md +2 -3
  63. data/docs/SchoolsResponse.md +0 -1
  64. data/docs/SchoolsUpdated.md +2 -3
  65. data/docs/Section.md +2 -3
  66. data/docs/SectionObject.md +0 -1
  67. data/docs/SectionResponse.md +0 -1
  68. data/docs/SectionsCreated.md +2 -3
  69. data/docs/SectionsDeleted.md +2 -3
  70. data/docs/SectionsResponse.md +0 -1
  71. data/docs/SectionsUpdated.md +2 -3
  72. data/docs/Student.md +3 -4
  73. data/docs/StudentObject.md +0 -1
  74. data/docs/StudentResponse.md +0 -1
  75. data/docs/StudentsCreated.md +2 -3
  76. data/docs/StudentsDeleted.md +2 -3
  77. data/docs/StudentsResponse.md +0 -1
  78. data/docs/StudentsUpdated.md +2 -3
  79. data/docs/Teacher.md +2 -3
  80. data/docs/TeacherObject.md +0 -1
  81. data/docs/TeacherResponse.md +0 -1
  82. data/docs/TeachersCreated.md +2 -3
  83. data/docs/TeachersDeleted.md +2 -3
  84. data/docs/TeachersResponse.md +0 -1
  85. data/docs/TeachersUpdated.md +2 -3
  86. data/docs/Term.md +2 -3
  87. data/docs/TermObject.md +0 -1
  88. data/docs/TermResponse.md +0 -1
  89. data/docs/TermsCreated.md +2 -3
  90. data/docs/TermsDeleted.md +2 -3
  91. data/docs/TermsResponse.md +0 -1
  92. data/docs/TermsUpdated.md +2 -3
  93. data/git_push.sh +55 -0
  94. data/lib/clever-ruby/api/data_api.rb +2999 -0
  95. data/lib/clever-ruby/api/events_api.rb +25 -20
  96. data/lib/clever-ruby/api_error.rb +23 -4
  97. data/lib/clever-ruby/configuration.rb +5 -9
  98. data/lib/clever-ruby/models/admin_name.rb +46 -22
  99. data/lib/clever-ruby/models/bad_request.rb +42 -20
  100. data/lib/clever-ruby/models/contact.rb +83 -55
  101. data/lib/clever-ruby/models/contact_object.rb +42 -20
  102. data/lib/clever-ruby/models/contact_response.rb +42 -20
  103. data/lib/clever-ruby/models/contacts_response.rb +44 -22
  104. data/lib/clever-ruby/models/course.rb +60 -36
  105. data/lib/clever-ruby/models/course_object.rb +42 -20
  106. data/lib/clever-ruby/models/course_response.rb +42 -20
  107. data/lib/clever-ruby/models/courses_response.rb +44 -22
  108. data/lib/clever-ruby/models/credentials.rb +42 -20
  109. data/lib/clever-ruby/models/district.rb +122 -94
  110. data/lib/clever-ruby/models/district_admin.rb +67 -44
  111. data/lib/clever-ruby/models/district_admin_object.rb +42 -20
  112. data/lib/clever-ruby/models/district_admin_response.rb +42 -20
  113. data/lib/clever-ruby/models/district_admins_response.rb +44 -22
  114. data/lib/clever-ruby/models/district_object.rb +42 -20
  115. data/lib/clever-ruby/models/district_response.rb +42 -20
  116. data/lib/clever-ruby/models/districts_response.rb +44 -22
  117. data/lib/clever-ruby/models/event.rb +60 -33
  118. data/lib/clever-ruby/models/event_response.rb +42 -20
  119. data/lib/clever-ruby/models/events_response.rb +44 -22
  120. data/lib/clever-ruby/models/internal_error.rb +42 -20
  121. data/lib/clever-ruby/models/link.rb +47 -25
  122. data/lib/clever-ruby/models/location.rb +73 -45
  123. data/lib/clever-ruby/models/name.rb +58 -33
  124. data/lib/clever-ruby/models/not_found.rb +42 -20
  125. data/lib/clever-ruby/models/principal.rb +55 -31
  126. data/lib/clever-ruby/models/school.rb +108 -80
  127. data/lib/clever-ruby/models/school_admin.rb +85 -61
  128. data/lib/clever-ruby/models/school_admin_object.rb +42 -20
  129. data/lib/clever-ruby/models/school_admin_response.rb +42 -20
  130. data/lib/clever-ruby/models/school_admins_response.rb +44 -22
  131. data/lib/clever-ruby/models/school_enrollment.rb +56 -34
  132. data/lib/clever-ruby/models/school_object.rb +42 -20
  133. data/lib/clever-ruby/models/school_response.rb +42 -20
  134. data/lib/clever-ruby/models/schools_response.rb +44 -22
  135. data/lib/clever-ruby/models/section.rb +104 -75
  136. data/lib/clever-ruby/models/section_object.rb +42 -20
  137. data/lib/clever-ruby/models/section_response.rb +42 -20
  138. data/lib/clever-ruby/models/sections_response.rb +44 -22
  139. data/lib/clever-ruby/models/student.rb +147 -126
  140. data/lib/clever-ruby/models/student_object.rb +42 -20
  141. data/lib/clever-ruby/models/student_response.rb +42 -20
  142. data/lib/clever-ruby/models/students_response.rb +44 -22
  143. data/lib/clever-ruby/models/teacher.rb +89 -63
  144. data/lib/clever-ruby/models/teacher_object.rb +42 -20
  145. data/lib/clever-ruby/models/teacher_response.rb +42 -20
  146. data/lib/clever-ruby/models/teachers_response.rb +44 -22
  147. data/lib/clever-ruby/models/term.rb +69 -44
  148. data/lib/clever-ruby/models/term_object.rb +42 -20
  149. data/lib/clever-ruby/models/term_response.rb +42 -20
  150. data/lib/clever-ruby/models/terms_response.rb +44 -22
  151. data/lib/clever-ruby/version.rb +4 -5
  152. data/lib/clever-ruby.rb +4 -14
  153. data/override/README-extension.md +1 -1
  154. data/override/override.sh +3 -0
  155. data/spec/api/data_api_spec.rb +671 -0
  156. data/spec/api/events_api_spec.rb +4 -3
  157. data/spec/api_client_spec.rb +21 -3
  158. data/spec/spec_helper.rb +4 -3
  159. metadata +27 -180
  160. data/docs/ContactsApi.md +0 -231
  161. data/docs/CoursesApi.md +0 -231
  162. data/docs/DistrictAdminsApi.md +0 -171
  163. data/docs/DistrictsApi.md +0 -113
  164. data/docs/SchoolAdminsApi.md +0 -231
  165. data/docs/SchoolsApi.md +0 -351
  166. data/docs/SectionsApi.md +0 -499
  167. data/docs/StudentsApi.md +0 -463
  168. data/docs/TeachersApi.md +0 -403
  169. data/docs/TermsApi.md +0 -231
  170. data/lib/clever-ruby/api/contacts_api.rb +0 -241
  171. data/lib/clever-ruby/api/courses_api.rb +0 -241
  172. data/lib/clever-ruby/api/district_admins_api.rb +0 -182
  173. data/lib/clever-ruby/api/districts_api.rb +0 -123
  174. data/lib/clever-ruby/api/school_admins_api.rb +0 -241
  175. data/lib/clever-ruby/api/schools_api.rb +0 -359
  176. data/lib/clever-ruby/api/sections_api.rb +0 -500
  177. data/lib/clever-ruby/api/students_api.rb +0 -468
  178. data/lib/clever-ruby/api/teachers_api.rb +0 -409
  179. data/lib/clever-ruby/api/terms_api.rb +0 -241
  180. data/spec/api/contacts_api_spec.rb +0 -84
  181. data/spec/api/courses_api_spec.rb +0 -84
  182. data/spec/api/district_admins_api_spec.rb +0 -70
  183. data/spec/api/districts_api_spec.rb +0 -56
  184. data/spec/api/school_admins_api_spec.rb +0 -84
  185. data/spec/api/schools_api_spec.rb +0 -112
  186. data/spec/api/sections_api_spec.rb +0 -142
  187. data/spec/api/students_api_spec.rb +0 -137
  188. data/spec/api/teachers_api_spec.rb +0 -123
  189. data/spec/api/terms_api_spec.rb +0 -84
@@ -1,137 +0,0 @@
1
- =begin
2
- #Data API
3
-
4
- #Serves the Clever Data API
5
-
6
- OpenAPI spec version: 2.1.0
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.51
10
- =end
11
-
12
- require 'spec_helper'
13
- require 'json'
14
-
15
- # Unit tests for Clever::StudentsApi
16
- # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
- # Please update as you see appropriate
18
- describe 'StudentsApi' do
19
- before do
20
- # run before each test
21
- @instance = Clever::StudentsApi.new
22
- end
23
-
24
- after do
25
- # run after each test
26
- end
27
-
28
- describe 'test an instance of StudentsApi' do
29
- it 'should create an instance of StudentsApi' do
30
- expect(@instance).to be_instance_of(Clever::StudentsApi)
31
- end
32
- end
33
-
34
- # unit tests for get_contacts_for_student
35
- # Returns the contacts for a student
36
- # @param id
37
- # @param [Hash] opts the optional parameters
38
- # @option opts [Integer] :limit
39
- # @option opts [String] :starting_after
40
- # @option opts [String] :ending_before
41
- # @return [ContactsResponse]
42
- describe 'get_contacts_for_student test' do
43
- it 'should work' do
44
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
- end
46
- end
47
-
48
- # unit tests for get_district_for_student
49
- # Returns the district for a student
50
- # @param id
51
- # @param [Hash] opts the optional parameters
52
- # @return [DistrictResponse]
53
- describe 'get_district_for_student test' do
54
- it 'should work' do
55
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
- end
57
- end
58
-
59
- # unit tests for get_school_for_student
60
- # Returns the primary school for a student
61
- # @param id
62
- # @param [Hash] opts the optional parameters
63
- # @return [SchoolResponse]
64
- describe 'get_school_for_student test' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- # unit tests for get_schools_for_student
71
- # Returns the schools for a student
72
- # @param id
73
- # @param [Hash] opts the optional parameters
74
- # @option opts [Integer] :limit
75
- # @option opts [String] :starting_after
76
- # @option opts [String] :ending_before
77
- # @return [SchoolsResponse]
78
- describe 'get_schools_for_student test' do
79
- it 'should work' do
80
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
- end
82
- end
83
-
84
- # unit tests for get_sections_for_student
85
- # Returns the sections for a student
86
- # @param id
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 [SectionsResponse]
92
- describe 'get_sections_for_student test' do
93
- it 'should work' do
94
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
- end
96
- end
97
-
98
- # unit tests for get_student
99
- # Returns a specific student
100
- # @param id
101
- # @param [Hash] opts the optional parameters
102
- # @return [StudentResponse]
103
- describe 'get_student test' do
104
- it 'should work' do
105
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
106
- end
107
- end
108
-
109
- # unit tests for get_students
110
- # Returns a list of students
111
- # @param [Hash] opts the optional parameters
112
- # @option opts [Integer] :limit
113
- # @option opts [String] :starting_after
114
- # @option opts [String] :ending_before
115
- # @option opts [String] :count
116
- # @return [StudentsResponse]
117
- describe 'get_students test' do
118
- it 'should work' do
119
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
120
- end
121
- end
122
-
123
- # unit tests for get_teachers_for_student
124
- # Returns the teachers for a student
125
- # @param id
126
- # @param [Hash] opts the optional parameters
127
- # @option opts [Integer] :limit
128
- # @option opts [String] :starting_after
129
- # @option opts [String] :ending_before
130
- # @return [TeachersResponse]
131
- describe 'get_teachers_for_student test' do
132
- it 'should work' do
133
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
- end
135
- end
136
-
137
- end
@@ -1,123 +0,0 @@
1
- =begin
2
- #Data API
3
-
4
- #Serves the Clever Data API
5
-
6
- OpenAPI spec version: 2.1.0
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.51
10
- =end
11
-
12
- require 'spec_helper'
13
- require 'json'
14
-
15
- # Unit tests for Clever::TeachersApi
16
- # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
- # Please update as you see appropriate
18
- describe 'TeachersApi' do
19
- before do
20
- # run before each test
21
- @instance = Clever::TeachersApi.new
22
- end
23
-
24
- after do
25
- # run after each test
26
- end
27
-
28
- describe 'test an instance of TeachersApi' do
29
- it 'should create an instance of TeachersApi' do
30
- expect(@instance).to be_instance_of(Clever::TeachersApi)
31
- end
32
- end
33
-
34
- # unit tests for get_district_for_teacher
35
- # Returns the district for a teacher
36
- # @param id
37
- # @param [Hash] opts the optional parameters
38
- # @return [DistrictResponse]
39
- describe 'get_district_for_teacher test' do
40
- it 'should work' do
41
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
42
- end
43
- end
44
-
45
- # unit tests for get_school_for_teacher
46
- # Retrieves school info for a teacher.
47
- # @param id
48
- # @param [Hash] opts the optional parameters
49
- # @return [SchoolResponse]
50
- describe 'get_school_for_teacher test' do
51
- it 'should work' do
52
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
53
- end
54
- end
55
-
56
- # unit tests for get_schools_for_teacher
57
- # Returns the schools for a teacher
58
- # @param id
59
- # @param [Hash] opts the optional parameters
60
- # @option opts [Integer] :limit
61
- # @option opts [String] :starting_after
62
- # @option opts [String] :ending_before
63
- # @return [SchoolsResponse]
64
- describe 'get_schools_for_teacher test' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- # unit tests for get_sections_for_teacher
71
- # Returns the sections for a teacher
72
- # @param id
73
- # @param [Hash] opts the optional parameters
74
- # @option opts [Integer] :limit
75
- # @option opts [String] :starting_after
76
- # @option opts [String] :ending_before
77
- # @return [SectionsResponse]
78
- describe 'get_sections_for_teacher test' do
79
- it 'should work' do
80
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
- end
82
- end
83
-
84
- # unit tests for get_students_for_teacher
85
- # Returns the students for a teacher
86
- # @param id
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 [StudentsResponse]
92
- describe 'get_students_for_teacher test' do
93
- it 'should work' do
94
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
- end
96
- end
97
-
98
- # unit tests for get_teacher
99
- # Returns a specific teacher
100
- # @param id
101
- # @param [Hash] opts the optional parameters
102
- # @return [TeacherResponse]
103
- describe 'get_teacher test' do
104
- it 'should work' do
105
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
106
- end
107
- end
108
-
109
- # unit tests for get_teachers
110
- # Returns a list of teachers
111
- # @param [Hash] opts the optional parameters
112
- # @option opts [Integer] :limit
113
- # @option opts [String] :starting_after
114
- # @option opts [String] :ending_before
115
- # @option opts [String] :count
116
- # @return [TeachersResponse]
117
- describe 'get_teachers test' do
118
- it 'should work' do
119
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
120
- end
121
- end
122
-
123
- end
@@ -1,84 +0,0 @@
1
- =begin
2
- #Data API
3
-
4
- #Serves the Clever Data API
5
-
6
- OpenAPI spec version: 2.1.0
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.51
10
- =end
11
-
12
- require 'spec_helper'
13
- require 'json'
14
-
15
- # Unit tests for Clever::TermsApi
16
- # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
- # Please update as you see appropriate
18
- describe 'TermsApi' do
19
- before do
20
- # run before each test
21
- @instance = Clever::TermsApi.new
22
- end
23
-
24
- after do
25
- # run after each test
26
- end
27
-
28
- describe 'test an instance of TermsApi' do
29
- it 'should create an instance of TermsApi' do
30
- expect(@instance).to be_instance_of(Clever::TermsApi)
31
- end
32
- end
33
-
34
- # unit tests for get_district_for_term
35
- # Returns the district for a term
36
- # @param id
37
- # @param [Hash] opts the optional parameters
38
- # @return [DistrictResponse]
39
- describe 'get_district_for_term test' do
40
- it 'should work' do
41
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
42
- end
43
- end
44
-
45
- # unit tests for get_sections_for_term
46
- # Returns the sections for a term
47
- # @param id
48
- # @param [Hash] opts the optional parameters
49
- # @option opts [Integer] :limit
50
- # @option opts [String] :starting_after
51
- # @option opts [String] :ending_before
52
- # @return [SectionsResponse]
53
- describe 'get_sections_for_term test' do
54
- it 'should work' do
55
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
- end
57
- end
58
-
59
- # unit tests for get_term
60
- # Returns a specific term
61
- # @param id
62
- # @param [Hash] opts the optional parameters
63
- # @return [TermResponse]
64
- describe 'get_term test' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
- # unit tests for get_terms
71
- # Returns a list of terms
72
- # @param [Hash] opts the optional parameters
73
- # @option opts [Integer] :limit
74
- # @option opts [String] :starting_after
75
- # @option opts [String] :ending_before
76
- # @option opts [String] :count
77
- # @return [TermsResponse]
78
- describe 'get_terms test' do
79
- it 'should work' do
80
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
- end
82
- end
83
-
84
- end