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
data/spec/api_client_spec.rb CHANGED
@@ -1,12 +1,13 @@
1
1
  =begin
2
- #Data API
2
+ #Clever API
3
3
 
4
- #Serves the Clever Data API
4
+ #The Clever API
5
5
 
6
6
  OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.51
9
+ Swagger Codegen version: 2.4.37
10
+
10
11
  =end
11
12
 
12
13
  require 'spec_helper'
@@ -88,6 +89,23 @@ describe Clever::ApiClient do
88
89
  end
89
90
  end
90
91
 
92
+ describe '#build_request' do
93
+ let(:config) { Clever::Configuration.new }
94
+ let(:api_client) { Clever::ApiClient.new(config) }
95
+
96
+ it 'does not send multipart to request' do
97
+ expect(Typhoeus::Request).to receive(:new).with(anything, hash_not_including(:multipart))
98
+ api_client.build_request(:get, '/test')
99
+ end
100
+
101
+ context 'when the content type is multipart' do
102
+ it 'sends multipart to request' do
103
+ expect(Typhoeus::Request).to receive(:new).with(anything, hash_including(headers: hash_including("Content-Type" => "multipart/form-data")))
104
+ api_client.build_request(:get, '/test', {header_params: { 'Content-Type' => 'multipart/form-data'}})
105
+ end
106
+ end
107
+ end
108
+
91
109
  describe '#deserialize' do
92
110
  it "handles Array<Integer>" do
93
111
  api_client = Clever::ApiClient.new
data/spec/spec_helper.rb CHANGED
@@ -1,12 +1,13 @@
1
1
  =begin
2
- #Data API
2
+ #Clever API
3
3
 
4
- #Serves the Clever Data API
4
+ #The Clever API
5
5
 
6
6
  OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.51
9
+ Swagger Codegen version: 2.4.37
10
+
10
11
  =end
11
12
 
12
13
  # load the gem
metadata CHANGED
@@ -1,75 +1,75 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: commonlit-clever-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.6.beta1
4
+ version: 2.1.6.beta3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Swagger-Codegen
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-30 00:00:00.000000000 Z
11
+ date: 2023-12-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
- name: typhoeus
14
+ name: addressable
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '1.0'
19
+ version: '2.3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 1.0.1
22
+ version: 2.3.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
26
26
  requirements:
27
27
  - - "~>"
28
28
  - !ruby/object:Gem::Version
29
- version: '1.0'
29
+ version: '2.3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 1.0.1
32
+ version: 2.3.0
33
33
  - !ruby/object:Gem::Dependency
34
- name: json
34
+ name: typhoeus
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
37
  - - "~>"
38
38
  - !ruby/object:Gem::Version
39
- version: '2.1'
39
+ version: '1.0'
40
40
  - - ">="
41
41
  - !ruby/object:Gem::Version
42
- version: 2.1.0
42
+ version: 1.0.1
43
43
  type: :runtime
44
44
  prerelease: false
45
45
  version_requirements: !ruby/object:Gem::Requirement
46
46
  requirements:
47
47
  - - "~>"
48
48
  - !ruby/object:Gem::Version
49
- version: '2.1'
49
+ version: '1.0'
50
50
  - - ">="
51
51
  - !ruby/object:Gem::Version
52
- version: 2.1.0
52
+ version: 1.0.1
53
53
  - !ruby/object:Gem::Dependency
54
- name: addressable
54
+ name: json
55
55
  requirement: !ruby/object:Gem::Requirement
56
56
  requirements:
57
57
  - - "~>"
58
58
  - !ruby/object:Gem::Version
59
- version: '2.3'
59
+ version: '2.1'
60
60
  - - ">="
61
61
  - !ruby/object:Gem::Version
62
- version: 2.3.0
62
+ version: 2.1.0
63
63
  type: :runtime
64
64
  prerelease: false
65
65
  version_requirements: !ruby/object:Gem::Requirement
66
66
  requirements:
67
67
  - - "~>"
68
68
  - !ruby/object:Gem::Version
69
- version: '2.3'
69
+ version: '2.1'
70
70
  - - ">="
71
71
  - !ruby/object:Gem::Version
72
- version: 2.3.0
72
+ version: 2.1.0
73
73
  - !ruby/object:Gem::Dependency
74
74
  name: rspec
75
75
  requirement: !ruby/object:Gem::Requirement
@@ -90,127 +90,7 @@ dependencies:
90
90
  - - ">="
91
91
  - !ruby/object:Gem::Version
92
92
  version: 3.6.0
93
- - !ruby/object:Gem::Dependency
94
- name: vcr
95
- requirement: !ruby/object:Gem::Requirement
96
- requirements:
97
- - - "~>"
98
- - !ruby/object:Gem::Version
99
- version: '3.0'
100
- - - ">="
101
- - !ruby/object:Gem::Version
102
- version: 3.0.1
103
- type: :development
104
- prerelease: false
105
- version_requirements: !ruby/object:Gem::Requirement
106
- requirements:
107
- - - "~>"
108
- - !ruby/object:Gem::Version
109
- version: '3.0'
110
- - - ">="
111
- - !ruby/object:Gem::Version
112
- version: 3.0.1
113
- - !ruby/object:Gem::Dependency
114
- name: webmock
115
- requirement: !ruby/object:Gem::Requirement
116
- requirements:
117
- - - "~>"
118
- - !ruby/object:Gem::Version
119
- version: '1.24'
120
- - - ">="
121
- - !ruby/object:Gem::Version
122
- version: 1.24.3
123
- type: :development
124
- prerelease: false
125
- version_requirements: !ruby/object:Gem::Requirement
126
- requirements:
127
- - - "~>"
128
- - !ruby/object:Gem::Version
129
- version: '1.24'
130
- - - ">="
131
- - !ruby/object:Gem::Version
132
- version: 1.24.3
133
- - !ruby/object:Gem::Dependency
134
- name: autotest
135
- requirement: !ruby/object:Gem::Requirement
136
- requirements:
137
- - - "~>"
138
- - !ruby/object:Gem::Version
139
- version: '4.4'
140
- - - ">="
141
- - !ruby/object:Gem::Version
142
- version: 4.4.6
143
- type: :development
144
- prerelease: false
145
- version_requirements: !ruby/object:Gem::Requirement
146
- requirements:
147
- - - "~>"
148
- - !ruby/object:Gem::Version
149
- version: '4.4'
150
- - - ">="
151
- - !ruby/object:Gem::Version
152
- version: 4.4.6
153
- - !ruby/object:Gem::Dependency
154
- name: autotest-rails-pure
155
- requirement: !ruby/object:Gem::Requirement
156
- requirements:
157
- - - "~>"
158
- - !ruby/object:Gem::Version
159
- version: '4.1'
160
- - - ">="
161
- - !ruby/object:Gem::Version
162
- version: 4.1.2
163
- type: :development
164
- prerelease: false
165
- version_requirements: !ruby/object:Gem::Requirement
166
- requirements:
167
- - - "~>"
168
- - !ruby/object:Gem::Version
169
- version: '4.1'
170
- - - ">="
171
- - !ruby/object:Gem::Version
172
- version: 4.1.2
173
- - !ruby/object:Gem::Dependency
174
- name: autotest-growl
175
- requirement: !ruby/object:Gem::Requirement
176
- requirements:
177
- - - "~>"
178
- - !ruby/object:Gem::Version
179
- version: '0.2'
180
- - - ">="
181
- - !ruby/object:Gem::Version
182
- version: 0.2.16
183
- type: :development
184
- prerelease: false
185
- version_requirements: !ruby/object:Gem::Requirement
186
- requirements:
187
- - - "~>"
188
- - !ruby/object:Gem::Version
189
- version: '0.2'
190
- - - ">="
191
- - !ruby/object:Gem::Version
192
- version: 0.2.16
193
- - !ruby/object:Gem::Dependency
194
- name: autotest-fsevent
195
- requirement: !ruby/object:Gem::Requirement
196
- requirements:
197
- - - "~>"
198
- - !ruby/object:Gem::Version
199
- version: '0.2'
200
- - - ">="
201
- - !ruby/object:Gem::Version
202
- version: 0.2.12
203
- type: :development
204
- prerelease: false
205
- version_requirements: !ruby/object:Gem::Requirement
206
- requirements:
207
- - - "~>"
208
- - !ruby/object:Gem::Version
209
- version: '0.2'
210
- - - ">="
211
- - !ruby/object:Gem::Version
212
- version: 0.2.12
213
- description: Serves the Clever Data API
93
+ description: The Clever API
214
94
  email:
215
95
  - ''
216
96
  executables: []
@@ -225,12 +105,13 @@ files:
225
105
  - README.md
226
106
  - Rakefile
227
107
  - clever-ruby.gemspec
108
+ - commonlit-clever-ruby-2.1.6.beta1.gem
109
+ - commonlit-clever-ruby-2.1.6.beta2.gem
228
110
  - docs/AdminName.md
229
111
  - docs/BadRequest.md
230
112
  - docs/Contact.md
231
113
  - docs/ContactObject.md
232
114
  - docs/ContactResponse.md
233
- - docs/ContactsApi.md
234
115
  - docs/ContactsCreated.md
235
116
  - docs/ContactsDeleted.md
236
117
  - docs/ContactsResponse.md
@@ -238,24 +119,22 @@ files:
238
119
  - docs/Course.md
239
120
  - docs/CourseObject.md
240
121
  - docs/CourseResponse.md
241
- - docs/CoursesApi.md
242
122
  - docs/CoursesCreated.md
243
123
  - docs/CoursesDeleted.md
244
124
  - docs/CoursesResponse.md
245
125
  - docs/CoursesUpdated.md
246
126
  - docs/Credentials.md
127
+ - docs/DataApi.md
247
128
  - docs/District.md
248
129
  - docs/DistrictAdmin.md
249
130
  - docs/DistrictAdminObject.md
250
131
  - docs/DistrictAdminResponse.md
251
- - docs/DistrictAdminsApi.md
252
132
  - docs/DistrictAdminsResponse.md
253
133
  - docs/DistrictObject.md
254
134
  - docs/DistrictResponse.md
255
135
  - docs/DistrictadminsCreated.md
256
136
  - docs/DistrictadminsDeleted.md
257
137
  - docs/DistrictadminsUpdated.md
258
- - docs/DistrictsApi.md
259
138
  - docs/DistrictsCreated.md
260
139
  - docs/DistrictsDeleted.md
261
140
  - docs/DistrictsResponse.md
@@ -274,7 +153,6 @@ files:
274
153
  - docs/SchoolAdmin.md
275
154
  - docs/SchoolAdminObject.md
276
155
  - docs/SchoolAdminResponse.md
277
- - docs/SchoolAdminsApi.md
278
156
  - docs/SchoolAdminsResponse.md
279
157
  - docs/SchoolEnrollment.md
280
158
  - docs/SchoolObject.md
@@ -282,7 +160,6 @@ files:
282
160
  - docs/SchooladminsCreated.md
283
161
  - docs/SchooladminsDeleted.md
284
162
  - docs/SchooladminsUpdated.md
285
- - docs/SchoolsApi.md
286
163
  - docs/SchoolsCreated.md
287
164
  - docs/SchoolsDeleted.md
288
165
  - docs/SchoolsResponse.md
@@ -290,7 +167,6 @@ files:
290
167
  - docs/Section.md
291
168
  - docs/SectionObject.md
292
169
  - docs/SectionResponse.md
293
- - docs/SectionsApi.md
294
170
  - docs/SectionsCreated.md
295
171
  - docs/SectionsDeleted.md
296
172
  - docs/SectionsResponse.md
@@ -298,7 +174,6 @@ files:
298
174
  - docs/Student.md
299
175
  - docs/StudentObject.md
300
176
  - docs/StudentResponse.md
301
- - docs/StudentsApi.md
302
177
  - docs/StudentsCreated.md
303
178
  - docs/StudentsDeleted.md
304
179
  - docs/StudentsResponse.md
@@ -306,7 +181,6 @@ files:
306
181
  - docs/Teacher.md
307
182
  - docs/TeacherObject.md
308
183
  - docs/TeacherResponse.md
309
- - docs/TeachersApi.md
310
184
  - docs/TeachersCreated.md
311
185
  - docs/TeachersDeleted.md
312
186
  - docs/TeachersResponse.md
@@ -314,24 +188,15 @@ files:
314
188
  - docs/Term.md
315
189
  - docs/TermObject.md
316
190
  - docs/TermResponse.md
317
- - docs/TermsApi.md
318
191
  - docs/TermsCreated.md
319
192
  - docs/TermsDeleted.md
320
193
  - docs/TermsResponse.md
321
194
  - docs/TermsUpdated.md
322
195
  - full-v2.yml
196
+ - git_push.sh
323
197
  - lib/clever-ruby.rb
324
- - lib/clever-ruby/api/contacts_api.rb
325
- - lib/clever-ruby/api/courses_api.rb
326
- - lib/clever-ruby/api/district_admins_api.rb
327
- - lib/clever-ruby/api/districts_api.rb
198
+ - lib/clever-ruby/api/data_api.rb
328
199
  - lib/clever-ruby/api/events_api.rb
329
- - lib/clever-ruby/api/school_admins_api.rb
330
- - lib/clever-ruby/api/schools_api.rb
331
- - lib/clever-ruby/api/sections_api.rb
332
- - lib/clever-ruby/api/students_api.rb
333
- - lib/clever-ruby/api/teachers_api.rb
334
- - lib/clever-ruby/api/terms_api.rb
335
200
  - lib/clever-ruby/api_client.rb
336
201
  - lib/clever-ruby/api_error.rb
337
202
  - lib/clever-ruby/configuration.rb
@@ -453,17 +318,8 @@ files:
453
318
  - override/models/terms_updated.rb
454
319
  - override/override.sh
455
320
  - sample/sample.rb
456
- - spec/api/contacts_api_spec.rb
457
- - spec/api/courses_api_spec.rb
458
- - spec/api/district_admins_api_spec.rb
459
- - spec/api/districts_api_spec.rb
321
+ - spec/api/data_api_spec.rb
460
322
  - spec/api/events_api_spec.rb
461
- - spec/api/school_admins_api_spec.rb
462
- - spec/api/schools_api_spec.rb
463
- - spec/api/sections_api_spec.rb
464
- - spec/api/students_api_spec.rb
465
- - spec/api/teachers_api_spec.rb
466
- - spec/api/terms_api_spec.rb
467
323
  - spec/api_client_spec.rb
468
324
  - spec/spec_helper.rb
469
325
  homepage: https://github.com/swagger-api/swagger-codegen
@@ -485,21 +341,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
485
341
  - !ruby/object:Gem::Version
486
342
  version: 1.3.1
487
343
  requirements: []
488
- rubygems_version: 3.4.18
344
+ rubygems_version: 3.1.6
489
345
  signing_key:
490
346
  specification_version: 4
491
- summary: Data API Ruby Gem
347
+ summary: Clever API Ruby Gem
492
348
  test_files:
493
- - spec/api/sections_api_spec.rb
494
- - spec/api/courses_api_spec.rb
495
- - spec/api/teachers_api_spec.rb
496
- - spec/api/schools_api_spec.rb
497
- - spec/api/school_admins_api_spec.rb
498
- - spec/api/students_api_spec.rb
349
+ - spec/api/data_api_spec.rb
499
350
  - spec/api/events_api_spec.rb
500
- - spec/api/districts_api_spec.rb
501
- - spec/api/district_admins_api_spec.rb
502
- - spec/api/terms_api_spec.rb
503
- - spec/api/contacts_api_spec.rb
504
351
  - spec/api_client_spec.rb
505
352
  - spec/spec_helper.rb
data/docs/ContactsApi.md DELETED
@@ -1,231 +0,0 @@
1
- # Clever::ContactsApi
2
-
3
- All URIs are relative to *https://api.clever.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_contact**](ContactsApi.md#get_contact) | **GET** /contacts/{id} |
8
- [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts |
9
- [**get_district_for_contact**](ContactsApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
10
- [**get_students_for_contact**](ContactsApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
11
-
12
-
13
- # **get_contact**
14
- > ContactResponse get_contact(id)
15
-
16
-
17
-
18
- Returns a specific student contact
19
-
20
- ### Example
21
- ```ruby
22
- # load the gem
23
- require 'clever-ruby'
24
- # setup authorization
25
- Clever.configure do |config|
26
- # Configure OAuth2 access token for authorization: oauth
27
- config.access_token = 'YOUR ACCESS TOKEN'
28
- end
29
-
30
- api_instance = Clever::ContactsApi.new
31
-
32
- id = 'id_example' # String |
33
-
34
-
35
- begin
36
- result = api_instance.get_contact(id)
37
- p result
38
- rescue Clever::ApiError => e
39
- puts "Exception when calling ContactsApi->get_contact: #{e}"
40
- end
41
- ```
42
-
43
- ### Parameters
44
-
45
- Name | Type | Description | Notes
46
- ------------- | ------------- | ------------- | -------------
47
- **id** | **String**| |
48
-
49
- ### Return type
50
-
51
- [**ContactResponse**](ContactResponse.md)
52
-
53
- ### Authorization
54
-
55
- [oauth](../README.md#oauth)
56
-
57
- ### HTTP request headers
58
-
59
- - **Content-Type**: Not defined
60
- - **Accept**: application/json
61
-
62
-
63
-
64
- # **get_contacts**
65
- > ContactsResponse get_contacts(opts)
66
-
67
-
68
-
69
- Returns a list of student contacts
70
-
71
- ### Example
72
- ```ruby
73
- # load the gem
74
- require 'clever-ruby'
75
- # setup authorization
76
- Clever.configure do |config|
77
- # Configure OAuth2 access token for authorization: oauth
78
- config.access_token = 'YOUR ACCESS TOKEN'
79
- end
80
-
81
- api_instance = Clever::ContactsApi.new
82
-
83
- opts = {
84
- limit: 56, # Integer |
85
- starting_after: 'starting_after_example', # String |
86
- ending_before: 'ending_before_example', # String |
87
- count: 'count_example' # String |
88
- }
89
-
90
- begin
91
- result = api_instance.get_contacts(opts)
92
- p result
93
- rescue Clever::ApiError => e
94
- puts "Exception when calling ContactsApi->get_contacts: #{e}"
95
- end
96
- ```
97
-
98
- ### Parameters
99
-
100
- Name | Type | Description | Notes
101
- ------------- | ------------- | ------------- | -------------
102
- **limit** | **Integer**| | [optional]
103
- **starting_after** | **String**| | [optional]
104
- **ending_before** | **String**| | [optional]
105
- **count** | **String**| | [optional]
106
-
107
- ### Return type
108
-
109
- [**ContactsResponse**](ContactsResponse.md)
110
-
111
- ### Authorization
112
-
113
- [oauth](../README.md#oauth)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
122
- # **get_district_for_contact**
123
- > DistrictResponse get_district_for_contact(id)
124
-
125
-
126
-
127
- Returns the district for a student contact
128
-
129
- ### Example
130
- ```ruby
131
- # load the gem
132
- require 'clever-ruby'
133
- # setup authorization
134
- Clever.configure do |config|
135
- # Configure OAuth2 access token for authorization: oauth
136
- config.access_token = 'YOUR ACCESS TOKEN'
137
- end
138
-
139
- api_instance = Clever::ContactsApi.new
140
-
141
- id = 'id_example' # String |
142
-
143
-
144
- begin
145
- result = api_instance.get_district_for_contact(id)
146
- p result
147
- rescue Clever::ApiError => e
148
- puts "Exception when calling ContactsApi->get_district_for_contact: #{e}"
149
- end
150
- ```
151
-
152
- ### Parameters
153
-
154
- Name | Type | Description | Notes
155
- ------------- | ------------- | ------------- | -------------
156
- **id** | **String**| |
157
-
158
- ### Return type
159
-
160
- [**DistrictResponse**](DistrictResponse.md)
161
-
162
- ### Authorization
163
-
164
- [oauth](../README.md#oauth)
165
-
166
- ### HTTP request headers
167
-
168
- - **Content-Type**: Not defined
169
- - **Accept**: application/json
170
-
171
-
172
-
173
- # **get_students_for_contact**
174
- > StudentsResponse get_students_for_contact(id, opts)
175
-
176
-
177
-
178
- Returns the students for a student contact
179
-
180
- ### Example
181
- ```ruby
182
- # load the gem
183
- require 'clever-ruby'
184
- # setup authorization
185
- Clever.configure do |config|
186
- # Configure OAuth2 access token for authorization: oauth
187
- config.access_token = 'YOUR ACCESS TOKEN'
188
- end
189
-
190
- api_instance = Clever::ContactsApi.new
191
-
192
- id = 'id_example' # String |
193
-
194
- opts = {
195
- limit: 56, # Integer |
196
- starting_after: 'starting_after_example', # String |
197
- ending_before: 'ending_before_example' # String |
198
- }
199
-
200
- begin
201
- result = api_instance.get_students_for_contact(id, opts)
202
- p result
203
- rescue Clever::ApiError => e
204
- puts "Exception when calling ContactsApi->get_students_for_contact: #{e}"
205
- end
206
- ```
207
-
208
- ### Parameters
209
-
210
- Name | Type | Description | Notes
211
- ------------- | ------------- | ------------- | -------------
212
- **id** | **String**| |
213
- **limit** | **Integer**| | [optional]
214
- **starting_after** | **String**| | [optional]
215
- **ending_before** | **String**| | [optional]
216
-
217
- ### Return type
218
-
219
- [**StudentsResponse**](StudentsResponse.md)
220
-
221
- ### Authorization
222
-
223
- [oauth](../README.md#oauth)
224
-
225
- ### HTTP request headers
226
-
227
- - **Content-Type**: Not defined
228
- - **Accept**: application/json
229
-
230
-
231
-