commonlit-clever-ruby 2.1.4 → 2.1.6.beta2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +46 -41
  4. data/Makefile +1 -1
  5. data/README.md +943 -11
  6. data/clever-ruby.gemspec +3 -10
  7. data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
  8. data/docs/AdminName.md +0 -1
  9. data/docs/BadRequest.md +0 -1
  10. data/docs/Contact.md +0 -1
  11. data/docs/ContactObject.md +0 -1
  12. data/docs/ContactResponse.md +0 -1
  13. data/docs/ContactsCreated.md +0 -1
  14. data/docs/ContactsDeleted.md +0 -1
  15. data/docs/ContactsResponse.md +0 -1
  16. data/docs/ContactsUpdated.md +0 -1
  17. data/docs/Course.md +0 -1
  18. data/docs/CourseObject.md +0 -1
  19. data/docs/CourseResponse.md +0 -1
  20. data/docs/CoursesCreated.md +0 -1
  21. data/docs/CoursesDeleted.md +0 -1
  22. data/docs/CoursesResponse.md +0 -1
  23. data/docs/CoursesUpdated.md +0 -1
  24. data/docs/Credentials.md +0 -1
  25. data/docs/DataApi.md +1 -69
  26. data/docs/District.md +0 -1
  27. data/docs/DistrictAdmin.md +0 -1
  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 +0 -1
  34. data/docs/DistrictadminsDeleted.md +0 -1
  35. data/docs/DistrictadminsUpdated.md +0 -1
  36. data/docs/DistrictsCreated.md +0 -1
  37. data/docs/DistrictsDeleted.md +0 -1
  38. data/docs/DistrictsResponse.md +0 -1
  39. data/docs/DistrictsUpdated.md +0 -1
  40. data/docs/Event.md +0 -1
  41. data/docs/EventResponse.md +0 -1
  42. data/docs/EventsApi.md +0 -3
  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 +0 -1
  47. data/docs/Name.md +0 -1
  48. data/docs/NotFound.md +0 -1
  49. data/docs/Principal.md +0 -1
  50. data/docs/School.md +0 -1
  51. data/docs/SchoolAdmin.md +0 -1
  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 +0 -1
  56. data/docs/SchoolObject.md +0 -1
  57. data/docs/SchoolResponse.md +0 -1
  58. data/docs/SchooladminsCreated.md +0 -1
  59. data/docs/SchooladminsDeleted.md +0 -1
  60. data/docs/SchooladminsUpdated.md +0 -1
  61. data/docs/SchoolsCreated.md +0 -1
  62. data/docs/SchoolsDeleted.md +0 -1
  63. data/docs/SchoolsResponse.md +0 -1
  64. data/docs/SchoolsUpdated.md +0 -1
  65. data/docs/Section.md +0 -1
  66. data/docs/SectionObject.md +0 -1
  67. data/docs/SectionResponse.md +0 -1
  68. data/docs/SectionsCreated.md +0 -1
  69. data/docs/SectionsDeleted.md +0 -1
  70. data/docs/SectionsResponse.md +0 -1
  71. data/docs/SectionsUpdated.md +0 -1
  72. data/docs/Student.md +0 -1
  73. data/docs/StudentObject.md +0 -1
  74. data/docs/StudentResponse.md +0 -1
  75. data/docs/StudentsCreated.md +0 -1
  76. data/docs/StudentsDeleted.md +0 -1
  77. data/docs/StudentsResponse.md +0 -1
  78. data/docs/StudentsUpdated.md +0 -1
  79. data/docs/Teacher.md +0 -1
  80. data/docs/TeacherObject.md +0 -1
  81. data/docs/TeacherResponse.md +0 -1
  82. data/docs/TeachersCreated.md +0 -1
  83. data/docs/TeachersDeleted.md +0 -1
  84. data/docs/TeachersResponse.md +0 -1
  85. data/docs/TeachersUpdated.md +0 -1
  86. data/docs/Term.md +0 -1
  87. data/docs/TermObject.md +0 -1
  88. data/docs/TermResponse.md +0 -1
  89. data/docs/TermsCreated.md +0 -1
  90. data/docs/TermsDeleted.md +0 -1
  91. data/docs/TermsResponse.md +0 -1
  92. data/docs/TermsUpdated.md +0 -1
  93. data/full-v2.yml +2541 -0
  94. data/lib/clever-ruby/api/data_api.rb +836 -635
  95. data/lib/clever-ruby/api/events_api.rb +23 -18
  96. data/lib/clever-ruby/api_client.rb +1 -0
  97. data/lib/clever-ruby/api_error.rb +21 -2
  98. data/lib/clever-ruby/configuration.rb +3 -7
  99. data/lib/clever-ruby/models/admin_name.rb +44 -20
  100. data/lib/clever-ruby/models/bad_request.rb +40 -18
  101. data/lib/clever-ruby/models/contact.rb +73 -45
  102. data/lib/clever-ruby/models/contact_object.rb +40 -18
  103. data/lib/clever-ruby/models/contact_response.rb +40 -18
  104. data/lib/clever-ruby/models/contacts_response.rb +42 -20
  105. data/lib/clever-ruby/models/course.rb +48 -24
  106. data/lib/clever-ruby/models/course_object.rb +40 -18
  107. data/lib/clever-ruby/models/course_response.rb +40 -18
  108. data/lib/clever-ruby/models/courses_response.rb +42 -20
  109. data/lib/clever-ruby/models/credentials.rb +40 -18
  110. data/lib/clever-ruby/models/district.rb +75 -47
  111. data/lib/clever-ruby/models/district_admin.rb +49 -26
  112. data/lib/clever-ruby/models/district_admin_object.rb +40 -18
  113. data/lib/clever-ruby/models/district_admin_response.rb +40 -18
  114. data/lib/clever-ruby/models/district_admins_response.rb +42 -20
  115. data/lib/clever-ruby/models/district_object.rb +40 -18
  116. data/lib/clever-ruby/models/district_response.rb +40 -18
  117. data/lib/clever-ruby/models/districts_response.rb +42 -20
  118. data/lib/clever-ruby/models/event.rb +49 -22
  119. data/lib/clever-ruby/models/event_response.rb +40 -18
  120. data/lib/clever-ruby/models/events_response.rb +42 -20
  121. data/lib/clever-ruby/models/internal_error.rb +40 -18
  122. data/lib/clever-ruby/models/link.rb +45 -23
  123. data/lib/clever-ruby/models/location.rb +56 -28
  124. data/lib/clever-ruby/models/name.rb +47 -22
  125. data/lib/clever-ruby/models/not_found.rb +40 -18
  126. data/lib/clever-ruby/models/principal.rb +44 -20
  127. data/lib/clever-ruby/models/school.rb +81 -53
  128. data/lib/clever-ruby/models/school_admin.rb +59 -35
  129. data/lib/clever-ruby/models/school_admin_object.rb +40 -18
  130. data/lib/clever-ruby/models/school_admin_response.rb +40 -18
  131. data/lib/clever-ruby/models/school_admins_response.rb +42 -20
  132. data/lib/clever-ruby/models/school_enrollment.rb +44 -22
  133. data/lib/clever-ruby/models/school_object.rb +40 -18
  134. data/lib/clever-ruby/models/school_response.rb +40 -18
  135. data/lib/clever-ruby/models/schools_response.rb +42 -20
  136. data/lib/clever-ruby/models/section.rb +84 -55
  137. data/lib/clever-ruby/models/section_object.rb +40 -18
  138. data/lib/clever-ruby/models/section_response.rb +40 -18
  139. data/lib/clever-ruby/models/sections_response.rb +42 -20
  140. data/lib/clever-ruby/models/student.rb +121 -100
  141. data/lib/clever-ruby/models/student_object.rb +40 -18
  142. data/lib/clever-ruby/models/student_response.rb +40 -18
  143. data/lib/clever-ruby/models/students_response.rb +42 -20
  144. data/lib/clever-ruby/models/teacher.rb +69 -43
  145. data/lib/clever-ruby/models/teacher_object.rb +40 -18
  146. data/lib/clever-ruby/models/teacher_response.rb +40 -18
  147. data/lib/clever-ruby/models/teachers_response.rb +42 -20
  148. data/lib/clever-ruby/models/term.rb +51 -26
  149. data/lib/clever-ruby/models/term_object.rb +40 -18
  150. data/lib/clever-ruby/models/term_response.rb +40 -18
  151. data/lib/clever-ruby/models/terms_response.rb +42 -20
  152. data/lib/clever-ruby/version.rb +2 -3
  153. data/lib/clever-ruby.rb +1 -2
  154. data/override/README-extension.md +4 -5
  155. data/override/api_client.rb +1 -0
  156. data/override/override.sh +7 -5
  157. data/spec/api/data_api_spec.rb +671 -0
  158. data/spec/api/events_api_spec.rb +61 -0
  159. data/spec/api_client_spec.rb +243 -0
  160. data/spec/spec_helper.rb +26 -18
  161. metadata +34 -150
  162. data/commonlit-clever-ruby-2.1.3.gem +0 -0
  163. data/spec/events.json +0 -227
  164. data/tags +0 -1681
data/README.md CHANGED
@@ -8,7 +8,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
8
8
 
9
9
  - API version: 2.1.0
10
10
  - Package version: 2.1.4
11
- - Build package: io.swagger.codegen.languages.RubyClientCodegen
11
+ - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
12
12
 
13
13
  ## Installation
14
14
 
@@ -53,7 +53,583 @@ Please follow the [installation](#installation) procedure and then run the follo
53
53
  ```ruby
54
54
  # Load the gem
55
55
  require 'clever-ruby'
56
+ # Setup authorization
57
+ Clever.configure do |config|
58
+ # Configure OAuth2 access token for authorization: oauth
59
+ config.access_token = 'YOUR ACCESS TOKEN'
60
+ end
61
+
62
+ api_instance = Clever::DataApi.new
63
+ id = 'id_example' # String |
64
+
65
+
66
+ begin
67
+ result = api_instance.get_contact(id)
68
+ p result
69
+ rescue Clever::ApiError => e
70
+ puts "Exception when calling DataApi->get_contact: #{e}"
71
+ end
72
+ # Setup authorization
73
+ Clever.configure do |config|
74
+ # Configure OAuth2 access token for authorization: oauth
75
+ config.access_token = 'YOUR ACCESS TOKEN'
76
+ end
77
+
78
+ api_instance = Clever::DataApi.new
79
+ opts = {
80
+ limit: 56, # Integer |
81
+ starting_after: 'starting_after_example', # String |
82
+ ending_before: 'ending_before_example', # String |
83
+ count: 'count_example' # String |
84
+ }
85
+
86
+ begin
87
+ result = api_instance.get_contacts(opts)
88
+ p result
89
+ rescue Clever::ApiError => e
90
+ puts "Exception when calling DataApi->get_contacts: #{e}"
91
+ end
92
+ # Setup authorization
93
+ Clever.configure do |config|
94
+ # Configure OAuth2 access token for authorization: oauth
95
+ config.access_token = 'YOUR ACCESS TOKEN'
96
+ end
97
+
98
+ api_instance = Clever::DataApi.new
99
+ id = 'id_example' # String |
100
+ opts = {
101
+ limit: 56, # Integer |
102
+ starting_after: 'starting_after_example', # String |
103
+ ending_before: 'ending_before_example' # String |
104
+ }
105
+
106
+ begin
107
+ result = api_instance.get_contacts_for_student(id, opts)
108
+ p result
109
+ rescue Clever::ApiError => e
110
+ puts "Exception when calling DataApi->get_contacts_for_student: #{e}"
111
+ end
112
+ # Setup authorization
113
+ Clever.configure do |config|
114
+ # Configure OAuth2 access token for authorization: oauth
115
+ config.access_token = 'YOUR ACCESS TOKEN'
116
+ end
117
+
118
+ api_instance = Clever::DataApi.new
119
+ id = 'id_example' # String |
120
+
121
+
122
+ begin
123
+ result = api_instance.get_course(id)
124
+ p result
125
+ rescue Clever::ApiError => e
126
+ puts "Exception when calling DataApi->get_course: #{e}"
127
+ end
128
+ # Setup authorization
129
+ Clever.configure do |config|
130
+ # Configure OAuth2 access token for authorization: oauth
131
+ config.access_token = 'YOUR ACCESS TOKEN'
132
+ end
133
+
134
+ api_instance = Clever::DataApi.new
135
+ id = 'id_example' # String |
136
+
137
+
138
+ begin
139
+ result = api_instance.get_course_for_section(id)
140
+ p result
141
+ rescue Clever::ApiError => e
142
+ puts "Exception when calling DataApi->get_course_for_section: #{e}"
143
+ end
144
+ # Setup authorization
145
+ Clever.configure do |config|
146
+ # Configure OAuth2 access token for authorization: oauth
147
+ config.access_token = 'YOUR ACCESS TOKEN'
148
+ end
149
+
150
+ api_instance = Clever::DataApi.new
151
+ opts = {
152
+ limit: 56, # Integer |
153
+ starting_after: 'starting_after_example', # String |
154
+ ending_before: 'ending_before_example', # String |
155
+ count: 'count_example' # String |
156
+ }
157
+
158
+ begin
159
+ result = api_instance.get_courses(opts)
160
+ p result
161
+ rescue Clever::ApiError => e
162
+ puts "Exception when calling DataApi->get_courses: #{e}"
163
+ end
164
+ # Setup authorization
165
+ Clever.configure do |config|
166
+ # Configure OAuth2 access token for authorization: oauth
167
+ config.access_token = 'YOUR ACCESS TOKEN'
168
+ end
169
+
170
+ api_instance = Clever::DataApi.new
171
+ id = 'id_example' # String |
172
+
173
+
174
+ begin
175
+ result = api_instance.get_district(id)
176
+ p result
177
+ rescue Clever::ApiError => e
178
+ puts "Exception when calling DataApi->get_district: #{e}"
179
+ end
180
+ # Setup authorization
181
+ Clever.configure do |config|
182
+ # Configure OAuth2 access token for authorization: oauth
183
+ config.access_token = 'YOUR ACCESS TOKEN'
184
+ end
185
+
186
+ api_instance = Clever::DataApi.new
187
+ id = 'id_example' # String |
188
+
189
+
190
+ begin
191
+ result = api_instance.get_district_admin(id)
192
+ p result
193
+ rescue Clever::ApiError => e
194
+ puts "Exception when calling DataApi->get_district_admin: #{e}"
195
+ end
196
+ # Setup authorization
197
+ Clever.configure do |config|
198
+ # Configure OAuth2 access token for authorization: oauth
199
+ config.access_token = 'YOUR ACCESS TOKEN'
200
+ end
201
+
202
+ api_instance = Clever::DataApi.new
203
+ opts = {
204
+ limit: 56, # Integer |
205
+ starting_after: 'starting_after_example', # String |
206
+ ending_before: 'ending_before_example', # String |
207
+ count: 'count_example' # String |
208
+ }
209
+
210
+ begin
211
+ result = api_instance.get_district_admins(opts)
212
+ p result
213
+ rescue Clever::ApiError => e
214
+ puts "Exception when calling DataApi->get_district_admins: #{e}"
215
+ end
216
+ # Setup authorization
217
+ Clever.configure do |config|
218
+ # Configure OAuth2 access token for authorization: oauth
219
+ config.access_token = 'YOUR ACCESS TOKEN'
220
+ end
221
+
222
+ api_instance = Clever::DataApi.new
223
+ id = 'id_example' # String |
224
+
225
+
226
+ begin
227
+ result = api_instance.get_district_for_contact(id)
228
+ p result
229
+ rescue Clever::ApiError => e
230
+ puts "Exception when calling DataApi->get_district_for_contact: #{e}"
231
+ end
232
+ # Setup authorization
233
+ Clever.configure do |config|
234
+ # Configure OAuth2 access token for authorization: oauth
235
+ config.access_token = 'YOUR ACCESS TOKEN'
236
+ end
237
+
238
+ api_instance = Clever::DataApi.new
239
+ id = 'id_example' # String |
240
+
241
+
242
+ begin
243
+ result = api_instance.get_district_for_course(id)
244
+ p result
245
+ rescue Clever::ApiError => e
246
+ puts "Exception when calling DataApi->get_district_for_course: #{e}"
247
+ end
248
+ # Setup authorization
249
+ Clever.configure do |config|
250
+ # Configure OAuth2 access token for authorization: oauth
251
+ config.access_token = 'YOUR ACCESS TOKEN'
252
+ end
253
+
254
+ api_instance = Clever::DataApi.new
255
+ id = 'id_example' # String |
256
+
257
+
258
+ begin
259
+ result = api_instance.get_district_for_district_admin(id)
260
+ p result
261
+ rescue Clever::ApiError => e
262
+ puts "Exception when calling DataApi->get_district_for_district_admin: #{e}"
263
+ end
264
+ # Setup authorization
265
+ Clever.configure do |config|
266
+ # Configure OAuth2 access token for authorization: oauth
267
+ config.access_token = 'YOUR ACCESS TOKEN'
268
+ end
269
+
270
+ api_instance = Clever::DataApi.new
271
+ id = 'id_example' # String |
272
+
273
+
274
+ begin
275
+ result = api_instance.get_district_for_school(id)
276
+ p result
277
+ rescue Clever::ApiError => e
278
+ puts "Exception when calling DataApi->get_district_for_school: #{e}"
279
+ end
280
+ # Setup authorization
281
+ Clever.configure do |config|
282
+ # Configure OAuth2 access token for authorization: oauth
283
+ config.access_token = 'YOUR ACCESS TOKEN'
284
+ end
285
+
286
+ api_instance = Clever::DataApi.new
287
+ id = 'id_example' # String |
288
+
289
+
290
+ begin
291
+ result = api_instance.get_district_for_school_admin(id)
292
+ p result
293
+ rescue Clever::ApiError => e
294
+ puts "Exception when calling DataApi->get_district_for_school_admin: #{e}"
295
+ end
296
+ # Setup authorization
297
+ Clever.configure do |config|
298
+ # Configure OAuth2 access token for authorization: oauth
299
+ config.access_token = 'YOUR ACCESS TOKEN'
300
+ end
301
+
302
+ api_instance = Clever::DataApi.new
303
+ id = 'id_example' # String |
304
+
305
+
306
+ begin
307
+ result = api_instance.get_district_for_section(id)
308
+ p result
309
+ rescue Clever::ApiError => e
310
+ puts "Exception when calling DataApi->get_district_for_section: #{e}"
311
+ end
312
+ # Setup authorization
313
+ Clever.configure do |config|
314
+ # Configure OAuth2 access token for authorization: oauth
315
+ config.access_token = 'YOUR ACCESS TOKEN'
316
+ end
317
+
318
+ api_instance = Clever::DataApi.new
319
+ id = 'id_example' # String |
320
+
321
+
322
+ begin
323
+ result = api_instance.get_district_for_student(id)
324
+ p result
325
+ rescue Clever::ApiError => e
326
+ puts "Exception when calling DataApi->get_district_for_student: #{e}"
327
+ end
328
+ # Setup authorization
329
+ Clever.configure do |config|
330
+ # Configure OAuth2 access token for authorization: oauth
331
+ config.access_token = 'YOUR ACCESS TOKEN'
332
+ end
333
+
334
+ api_instance = Clever::DataApi.new
335
+ id = 'id_example' # String |
336
+
337
+
338
+ begin
339
+ result = api_instance.get_district_for_teacher(id)
340
+ p result
341
+ rescue Clever::ApiError => e
342
+ puts "Exception when calling DataApi->get_district_for_teacher: #{e}"
343
+ end
344
+ # Setup authorization
345
+ Clever.configure do |config|
346
+ # Configure OAuth2 access token for authorization: oauth
347
+ config.access_token = 'YOUR ACCESS TOKEN'
348
+ end
349
+
350
+ api_instance = Clever::DataApi.new
351
+ id = 'id_example' # String |
352
+
353
+
354
+ begin
355
+ result = api_instance.get_district_for_term(id)
356
+ p result
357
+ rescue Clever::ApiError => e
358
+ puts "Exception when calling DataApi->get_district_for_term: #{e}"
359
+ end
360
+ # Setup authorization
361
+ Clever.configure do |config|
362
+ # Configure OAuth2 access token for authorization: oauth
363
+ config.access_token = 'YOUR ACCESS TOKEN'
364
+ end
365
+
366
+ api_instance = Clever::DataApi.new
367
+ opts = {
368
+ count: 'count_example' # String |
369
+ }
370
+
371
+ begin
372
+ result = api_instance.get_districts(opts)
373
+ p result
374
+ rescue Clever::ApiError => e
375
+ puts "Exception when calling DataApi->get_districts: #{e}"
376
+ end
377
+ # Setup authorization
378
+ Clever.configure do |config|
379
+ # Configure OAuth2 access token for authorization: oauth
380
+ config.access_token = 'YOUR ACCESS TOKEN'
381
+ end
382
+
383
+ api_instance = Clever::DataApi.new
384
+ id = 'id_example' # String |
385
+
386
+
387
+ begin
388
+ result = api_instance.get_school(id)
389
+ p result
390
+ rescue Clever::ApiError => e
391
+ puts "Exception when calling DataApi->get_school: #{e}"
392
+ end
393
+ # Setup authorization
394
+ Clever.configure do |config|
395
+ # Configure OAuth2 access token for authorization: oauth
396
+ config.access_token = 'YOUR ACCESS TOKEN'
397
+ end
398
+
399
+ api_instance = Clever::DataApi.new
400
+ id = 'id_example' # String |
401
+
402
+
403
+ begin
404
+ result = api_instance.get_school_admin(id)
405
+ p result
406
+ rescue Clever::ApiError => e
407
+ puts "Exception when calling DataApi->get_school_admin: #{e}"
408
+ end
409
+ # Setup authorization
410
+ Clever.configure do |config|
411
+ # Configure OAuth2 access token for authorization: oauth
412
+ config.access_token = 'YOUR ACCESS TOKEN'
413
+ end
414
+
415
+ api_instance = Clever::DataApi.new
416
+ opts = {
417
+ limit: 56, # Integer |
418
+ starting_after: 'starting_after_example', # String |
419
+ ending_before: 'ending_before_example', # String |
420
+ count: 'count_example' # String |
421
+ }
422
+
423
+ begin
424
+ result = api_instance.get_school_admins(opts)
425
+ p result
426
+ rescue Clever::ApiError => e
427
+ puts "Exception when calling DataApi->get_school_admins: #{e}"
428
+ end
429
+ # Setup authorization
430
+ Clever.configure do |config|
431
+ # Configure OAuth2 access token for authorization: oauth
432
+ config.access_token = 'YOUR ACCESS TOKEN'
433
+ end
434
+
435
+ api_instance = Clever::DataApi.new
436
+ id = 'id_example' # String |
437
+
438
+
439
+ begin
440
+ result = api_instance.get_school_for_section(id)
441
+ p result
442
+ rescue Clever::ApiError => e
443
+ puts "Exception when calling DataApi->get_school_for_section: #{e}"
444
+ end
445
+ # Setup authorization
446
+ Clever.configure do |config|
447
+ # Configure OAuth2 access token for authorization: oauth
448
+ config.access_token = 'YOUR ACCESS TOKEN'
449
+ end
450
+
451
+ api_instance = Clever::DataApi.new
452
+ id = 'id_example' # String |
453
+
454
+
455
+ begin
456
+ result = api_instance.get_school_for_student(id)
457
+ p result
458
+ rescue Clever::ApiError => e
459
+ puts "Exception when calling DataApi->get_school_for_student: #{e}"
460
+ end
461
+ # Setup authorization
462
+ Clever.configure do |config|
463
+ # Configure OAuth2 access token for authorization: oauth
464
+ config.access_token = 'YOUR ACCESS TOKEN'
465
+ end
466
+
467
+ api_instance = Clever::DataApi.new
468
+ id = 'id_example' # String |
469
+
470
+
471
+ begin
472
+ result = api_instance.get_school_for_teacher(id)
473
+ p result
474
+ rescue Clever::ApiError => e
475
+ puts "Exception when calling DataApi->get_school_for_teacher: #{e}"
476
+ end
477
+ # Setup authorization
478
+ Clever.configure do |config|
479
+ # Configure OAuth2 access token for authorization: oauth
480
+ config.access_token = 'YOUR ACCESS TOKEN'
481
+ end
482
+
483
+ api_instance = Clever::DataApi.new
484
+ opts = {
485
+ limit: 56, # Integer |
486
+ starting_after: 'starting_after_example', # String |
487
+ ending_before: 'ending_before_example', # String |
488
+ count: 'count_example' # String |
489
+ }
490
+
491
+ begin
492
+ result = api_instance.get_schools(opts)
493
+ p result
494
+ rescue Clever::ApiError => e
495
+ puts "Exception when calling DataApi->get_schools: #{e}"
496
+ end
497
+ # Setup authorization
498
+ Clever.configure do |config|
499
+ # Configure OAuth2 access token for authorization: oauth
500
+ config.access_token = 'YOUR ACCESS TOKEN'
501
+ end
502
+
503
+ api_instance = Clever::DataApi.new
504
+ id = 'id_example' # String |
505
+ opts = {
506
+ limit: 56, # Integer |
507
+ starting_after: 'starting_after_example', # String |
508
+ ending_before: 'ending_before_example' # String |
509
+ }
510
+
511
+ begin
512
+ result = api_instance.get_schools_for_school_admin(id, opts)
513
+ p result
514
+ rescue Clever::ApiError => e
515
+ puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}"
516
+ end
517
+ # Setup authorization
518
+ Clever.configure do |config|
519
+ # Configure OAuth2 access token for authorization: oauth
520
+ config.access_token = 'YOUR ACCESS TOKEN'
521
+ end
522
+
523
+ api_instance = Clever::DataApi.new
524
+ id = 'id_example' # String |
525
+ opts = {
526
+ limit: 56, # Integer |
527
+ starting_after: 'starting_after_example', # String |
528
+ ending_before: 'ending_before_example' # String |
529
+ }
530
+
531
+ begin
532
+ result = api_instance.get_schools_for_student(id, opts)
533
+ p result
534
+ rescue Clever::ApiError => e
535
+ puts "Exception when calling DataApi->get_schools_for_student: #{e}"
536
+ end
537
+ # Setup authorization
538
+ Clever.configure do |config|
539
+ # Configure OAuth2 access token for authorization: oauth
540
+ config.access_token = 'YOUR ACCESS TOKEN'
541
+ end
542
+
543
+ api_instance = Clever::DataApi.new
544
+ id = 'id_example' # String |
545
+ opts = {
546
+ limit: 56, # Integer |
547
+ starting_after: 'starting_after_example', # String |
548
+ ending_before: 'ending_before_example' # String |
549
+ }
550
+
551
+ begin
552
+ result = api_instance.get_schools_for_teacher(id, opts)
553
+ p result
554
+ rescue Clever::ApiError => e
555
+ puts "Exception when calling DataApi->get_schools_for_teacher: #{e}"
556
+ end
557
+ # Setup authorization
558
+ Clever.configure do |config|
559
+ # Configure OAuth2 access token for authorization: oauth
560
+ config.access_token = 'YOUR ACCESS TOKEN'
561
+ end
562
+
563
+ api_instance = Clever::DataApi.new
564
+ id = 'id_example' # String |
565
+
566
+
567
+ begin
568
+ result = api_instance.get_section(id)
569
+ p result
570
+ rescue Clever::ApiError => e
571
+ puts "Exception when calling DataApi->get_section: #{e}"
572
+ end
573
+ # Setup authorization
574
+ Clever.configure do |config|
575
+ # Configure OAuth2 access token for authorization: oauth
576
+ config.access_token = 'YOUR ACCESS TOKEN'
577
+ end
578
+
579
+ api_instance = Clever::DataApi.new
580
+ opts = {
581
+ limit: 56, # Integer |
582
+ starting_after: 'starting_after_example', # String |
583
+ ending_before: 'ending_before_example', # String |
584
+ count: 'count_example' # String |
585
+ }
586
+
587
+ begin
588
+ result = api_instance.get_sections(opts)
589
+ p result
590
+ rescue Clever::ApiError => e
591
+ puts "Exception when calling DataApi->get_sections: #{e}"
592
+ end
593
+ # Setup authorization
594
+ Clever.configure do |config|
595
+ # Configure OAuth2 access token for authorization: oauth
596
+ config.access_token = 'YOUR ACCESS TOKEN'
597
+ end
598
+
599
+ api_instance = Clever::DataApi.new
600
+ id = 'id_example' # String |
601
+ opts = {
602
+ limit: 56, # Integer |
603
+ starting_after: 'starting_after_example', # String |
604
+ ending_before: 'ending_before_example' # String |
605
+ }
606
+
607
+ begin
608
+ result = api_instance.get_sections_for_course(id, opts)
609
+ p result
610
+ rescue Clever::ApiError => e
611
+ puts "Exception when calling DataApi->get_sections_for_course: #{e}"
612
+ end
613
+ # Setup authorization
614
+ Clever.configure do |config|
615
+ # Configure OAuth2 access token for authorization: oauth
616
+ config.access_token = 'YOUR ACCESS TOKEN'
617
+ end
618
+
619
+ api_instance = Clever::DataApi.new
620
+ id = 'id_example' # String |
621
+ opts = {
622
+ limit: 56, # Integer |
623
+ starting_after: 'starting_after_example', # String |
624
+ ending_before: 'ending_before_example' # String |
625
+ }
56
626
 
627
+ begin
628
+ result = api_instance.get_sections_for_school(id, opts)
629
+ p result
630
+ rescue Clever::ApiError => e
631
+ puts "Exception when calling DataApi->get_sections_for_school: #{e}"
632
+ end
57
633
  # Setup authorization
58
634
  Clever.configure do |config|
59
635
  # Configure OAuth2 access token for authorization: oauth
@@ -61,17 +637,376 @@ Clever.configure do |config|
61
637
  end
62
638
 
63
639
  api_instance = Clever::DataApi.new
640
+ id = 'id_example' # String |
641
+ opts = {
642
+ limit: 56, # Integer |
643
+ starting_after: 'starting_after_example', # String |
644
+ ending_before: 'ending_before_example' # String |
645
+ }
646
+
647
+ begin
648
+ result = api_instance.get_sections_for_student(id, opts)
649
+ p result
650
+ rescue Clever::ApiError => e
651
+ puts "Exception when calling DataApi->get_sections_for_student: #{e}"
652
+ end
653
+ # Setup authorization
654
+ Clever.configure do |config|
655
+ # Configure OAuth2 access token for authorization: oauth
656
+ config.access_token = 'YOUR ACCESS TOKEN'
657
+ end
64
658
 
659
+ api_instance = Clever::DataApi.new
65
660
  id = 'id_example' # String |
661
+ opts = {
662
+ limit: 56, # Integer |
663
+ starting_after: 'starting_after_example', # String |
664
+ ending_before: 'ending_before_example' # String |
665
+ }
666
+
667
+ begin
668
+ result = api_instance.get_sections_for_teacher(id, opts)
669
+ p result
670
+ rescue Clever::ApiError => e
671
+ puts "Exception when calling DataApi->get_sections_for_teacher: #{e}"
672
+ end
673
+ # Setup authorization
674
+ Clever.configure do |config|
675
+ # Configure OAuth2 access token for authorization: oauth
676
+ config.access_token = 'YOUR ACCESS TOKEN'
677
+ end
66
678
 
679
+ api_instance = Clever::DataApi.new
680
+ id = 'id_example' # String |
681
+ opts = {
682
+ limit: 56, # Integer |
683
+ starting_after: 'starting_after_example', # String |
684
+ ending_before: 'ending_before_example' # String |
685
+ }
67
686
 
68
687
  begin
69
- result = api_instance.get_contact(id)
688
+ result = api_instance.get_sections_for_term(id, opts)
70
689
  p result
71
690
  rescue Clever::ApiError => e
72
- puts "Exception when calling DataApi->get_contact: #{e}"
691
+ puts "Exception when calling DataApi->get_sections_for_term: #{e}"
692
+ end
693
+ # Setup authorization
694
+ Clever.configure do |config|
695
+ # Configure OAuth2 access token for authorization: oauth
696
+ config.access_token = 'YOUR ACCESS TOKEN'
697
+ end
698
+
699
+ api_instance = Clever::DataApi.new
700
+ id = 'id_example' # String |
701
+
702
+
703
+ begin
704
+ result = api_instance.get_student(id)
705
+ p result
706
+ rescue Clever::ApiError => e
707
+ puts "Exception when calling DataApi->get_student: #{e}"
708
+ end
709
+ # Setup authorization
710
+ Clever.configure do |config|
711
+ # Configure OAuth2 access token for authorization: oauth
712
+ config.access_token = 'YOUR ACCESS TOKEN'
713
+ end
714
+
715
+ api_instance = Clever::DataApi.new
716
+ opts = {
717
+ limit: 56, # Integer |
718
+ starting_after: 'starting_after_example', # String |
719
+ ending_before: 'ending_before_example', # String |
720
+ count: 'count_example' # String |
721
+ }
722
+
723
+ begin
724
+ result = api_instance.get_students(opts)
725
+ p result
726
+ rescue Clever::ApiError => e
727
+ puts "Exception when calling DataApi->get_students: #{e}"
728
+ end
729
+ # Setup authorization
730
+ Clever.configure do |config|
731
+ # Configure OAuth2 access token for authorization: oauth
732
+ config.access_token = 'YOUR ACCESS TOKEN'
733
+ end
734
+
735
+ api_instance = Clever::DataApi.new
736
+ id = 'id_example' # String |
737
+ opts = {
738
+ limit: 56, # Integer |
739
+ starting_after: 'starting_after_example', # String |
740
+ ending_before: 'ending_before_example' # String |
741
+ }
742
+
743
+ begin
744
+ result = api_instance.get_students_for_contact(id, opts)
745
+ p result
746
+ rescue Clever::ApiError => e
747
+ puts "Exception when calling DataApi->get_students_for_contact: #{e}"
748
+ end
749
+ # Setup authorization
750
+ Clever.configure do |config|
751
+ # Configure OAuth2 access token for authorization: oauth
752
+ config.access_token = 'YOUR ACCESS TOKEN'
753
+ end
754
+
755
+ api_instance = Clever::DataApi.new
756
+ id = 'id_example' # String |
757
+ opts = {
758
+ limit: 56, # Integer |
759
+ starting_after: 'starting_after_example', # String |
760
+ ending_before: 'ending_before_example' # String |
761
+ }
762
+
763
+ begin
764
+ result = api_instance.get_students_for_school(id, opts)
765
+ p result
766
+ rescue Clever::ApiError => e
767
+ puts "Exception when calling DataApi->get_students_for_school: #{e}"
768
+ end
769
+ # Setup authorization
770
+ Clever.configure do |config|
771
+ # Configure OAuth2 access token for authorization: oauth
772
+ config.access_token = 'YOUR ACCESS TOKEN'
773
+ end
774
+
775
+ api_instance = Clever::DataApi.new
776
+ id = 'id_example' # String |
777
+ opts = {
778
+ limit: 56, # Integer |
779
+ starting_after: 'starting_after_example', # String |
780
+ ending_before: 'ending_before_example' # String |
781
+ }
782
+
783
+ begin
784
+ result = api_instance.get_students_for_section(id, opts)
785
+ p result
786
+ rescue Clever::ApiError => e
787
+ puts "Exception when calling DataApi->get_students_for_section: #{e}"
788
+ end
789
+ # Setup authorization
790
+ Clever.configure do |config|
791
+ # Configure OAuth2 access token for authorization: oauth
792
+ config.access_token = 'YOUR ACCESS TOKEN'
793
+ end
794
+
795
+ api_instance = Clever::DataApi.new
796
+ id = 'id_example' # String |
797
+ opts = {
798
+ limit: 56, # Integer |
799
+ starting_after: 'starting_after_example', # String |
800
+ ending_before: 'ending_before_example' # String |
801
+ }
802
+
803
+ begin
804
+ result = api_instance.get_students_for_teacher(id, opts)
805
+ p result
806
+ rescue Clever::ApiError => e
807
+ puts "Exception when calling DataApi->get_students_for_teacher: #{e}"
808
+ end
809
+ # Setup authorization
810
+ Clever.configure do |config|
811
+ # Configure OAuth2 access token for authorization: oauth
812
+ config.access_token = 'YOUR ACCESS TOKEN'
813
+ end
814
+
815
+ api_instance = Clever::DataApi.new
816
+ id = 'id_example' # String |
817
+
818
+
819
+ begin
820
+ result = api_instance.get_teacher(id)
821
+ p result
822
+ rescue Clever::ApiError => e
823
+ puts "Exception when calling DataApi->get_teacher: #{e}"
824
+ end
825
+ # Setup authorization
826
+ Clever.configure do |config|
827
+ # Configure OAuth2 access token for authorization: oauth
828
+ config.access_token = 'YOUR ACCESS TOKEN'
73
829
  end
74
830
 
831
+ api_instance = Clever::DataApi.new
832
+ id = 'id_example' # String |
833
+
834
+
835
+ begin
836
+ result = api_instance.get_teacher_for_section(id)
837
+ p result
838
+ rescue Clever::ApiError => e
839
+ puts "Exception when calling DataApi->get_teacher_for_section: #{e}"
840
+ end
841
+ # Setup authorization
842
+ Clever.configure do |config|
843
+ # Configure OAuth2 access token for authorization: oauth
844
+ config.access_token = 'YOUR ACCESS TOKEN'
845
+ end
846
+
847
+ api_instance = Clever::DataApi.new
848
+ opts = {
849
+ limit: 56, # Integer |
850
+ starting_after: 'starting_after_example', # String |
851
+ ending_before: 'ending_before_example', # String |
852
+ count: 'count_example' # String |
853
+ }
854
+
855
+ begin
856
+ result = api_instance.get_teachers(opts)
857
+ p result
858
+ rescue Clever::ApiError => e
859
+ puts "Exception when calling DataApi->get_teachers: #{e}"
860
+ end
861
+ # Setup authorization
862
+ Clever.configure do |config|
863
+ # Configure OAuth2 access token for authorization: oauth
864
+ config.access_token = 'YOUR ACCESS TOKEN'
865
+ end
866
+
867
+ api_instance = Clever::DataApi.new
868
+ id = 'id_example' # String |
869
+ opts = {
870
+ limit: 56, # Integer |
871
+ starting_after: 'starting_after_example', # String |
872
+ ending_before: 'ending_before_example' # String |
873
+ }
874
+
875
+ begin
876
+ result = api_instance.get_teachers_for_school(id, opts)
877
+ p result
878
+ rescue Clever::ApiError => e
879
+ puts "Exception when calling DataApi->get_teachers_for_school: #{e}"
880
+ end
881
+ # Setup authorization
882
+ Clever.configure do |config|
883
+ # Configure OAuth2 access token for authorization: oauth
884
+ config.access_token = 'YOUR ACCESS TOKEN'
885
+ end
886
+
887
+ api_instance = Clever::DataApi.new
888
+ id = 'id_example' # String |
889
+ opts = {
890
+ limit: 56, # Integer |
891
+ starting_after: 'starting_after_example', # String |
892
+ ending_before: 'ending_before_example' # String |
893
+ }
894
+
895
+ begin
896
+ result = api_instance.get_teachers_for_section(id, opts)
897
+ p result
898
+ rescue Clever::ApiError => e
899
+ puts "Exception when calling DataApi->get_teachers_for_section: #{e}"
900
+ end
901
+ # Setup authorization
902
+ Clever.configure do |config|
903
+ # Configure OAuth2 access token for authorization: oauth
904
+ config.access_token = 'YOUR ACCESS TOKEN'
905
+ end
906
+
907
+ api_instance = Clever::DataApi.new
908
+ id = 'id_example' # String |
909
+ opts = {
910
+ limit: 56, # Integer |
911
+ starting_after: 'starting_after_example', # String |
912
+ ending_before: 'ending_before_example' # String |
913
+ }
914
+
915
+ begin
916
+ result = api_instance.get_teachers_for_student(id, opts)
917
+ p result
918
+ rescue Clever::ApiError => e
919
+ puts "Exception when calling DataApi->get_teachers_for_student: #{e}"
920
+ end
921
+ # Setup authorization
922
+ Clever.configure do |config|
923
+ # Configure OAuth2 access token for authorization: oauth
924
+ config.access_token = 'YOUR ACCESS TOKEN'
925
+ end
926
+
927
+ api_instance = Clever::DataApi.new
928
+ id = 'id_example' # String |
929
+
930
+
931
+ begin
932
+ result = api_instance.get_term(id)
933
+ p result
934
+ rescue Clever::ApiError => e
935
+ puts "Exception when calling DataApi->get_term: #{e}"
936
+ end
937
+ # Setup authorization
938
+ Clever.configure do |config|
939
+ # Configure OAuth2 access token for authorization: oauth
940
+ config.access_token = 'YOUR ACCESS TOKEN'
941
+ end
942
+
943
+ api_instance = Clever::DataApi.new
944
+ id = 'id_example' # String |
945
+
946
+
947
+ begin
948
+ result = api_instance.get_term_for_section(id)
949
+ p result
950
+ rescue Clever::ApiError => e
951
+ puts "Exception when calling DataApi->get_term_for_section: #{e}"
952
+ end
953
+ # Setup authorization
954
+ Clever.configure do |config|
955
+ # Configure OAuth2 access token for authorization: oauth
956
+ config.access_token = 'YOUR ACCESS TOKEN'
957
+ end
958
+
959
+ api_instance = Clever::DataApi.new
960
+ opts = {
961
+ limit: 56, # Integer |
962
+ starting_after: 'starting_after_example', # String |
963
+ ending_before: 'ending_before_example', # String |
964
+ count: 'count_example' # String |
965
+ }
966
+
967
+ begin
968
+ result = api_instance.get_terms(opts)
969
+ p result
970
+ rescue Clever::ApiError => e
971
+ puts "Exception when calling DataApi->get_terms: #{e}"
972
+ end
973
+ # Setup authorization
974
+ Clever.configure do |config|
975
+ # Configure OAuth2 access token for authorization: oauth
976
+ config.access_token = 'YOUR ACCESS TOKEN'
977
+ end
978
+
979
+ api_instance = Clever::EventsApi.new
980
+ id = 'id_example' # String |
981
+
982
+
983
+ begin
984
+ result = api_instance.get_event(id)
985
+ p result
986
+ rescue Clever::ApiError => e
987
+ puts "Exception when calling EventsApi->get_event: #{e}"
988
+ end
989
+ # Setup authorization
990
+ Clever.configure do |config|
991
+ # Configure OAuth2 access token for authorization: oauth
992
+ config.access_token = 'YOUR ACCESS TOKEN'
993
+ end
994
+
995
+ api_instance = Clever::EventsApi.new
996
+ opts = {
997
+ limit: 56, # Integer |
998
+ starting_after: 'starting_after_example', # String |
999
+ ending_before: 'ending_before_example', # String |
1000
+ school: 'school_example', # String |
1001
+ record_type: ['record_type_example'] # Array<String> |
1002
+ }
1003
+
1004
+ begin
1005
+ result = api_instance.get_events(opts)
1006
+ p result
1007
+ rescue Clever::ApiError => e
1008
+ puts "Exception when calling EventsApi->get_events: #{e}"
1009
+ end
75
1010
  ```
76
1011
 
77
1012
  ## Documentation for API Endpoints
@@ -134,7 +1069,6 @@ Class | Method | HTTP request | Description
134
1069
  *Clever::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} |
135
1070
  *Clever::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events |
136
1071
 
137
-
138
1072
  ## Documentation for Models
139
1073
 
140
1074
  - [Clever::AdminName](docs/AdminName.md)
@@ -221,7 +1155,6 @@ Class | Method | HTTP request | Description
221
1155
  - [Clever::TermsResponse](docs/TermsResponse.md)
222
1156
  - [Clever::TermsUpdated](docs/TermsUpdated.md)
223
1157
 
224
-
225
1158
  ## Documentation for Authorization
226
1159
 
227
1160
 
@@ -230,15 +1163,14 @@ Class | Method | HTTP request | Description
230
1163
  - **Type**: OAuth
231
1164
  - **Flow**: accessCode
232
1165
  - **Authorization URL**: https://clever.com/oauth/authorize
233
- - **Scopes**: N/A
1166
+ - **Scopes**:
234
1167
 
235
1168
  ## Previous Versions
236
1169
 
237
1170
  The current client support v2.0 of the API. For v1.2 please use:
238
1171
 
239
- - https://rubygems.org/gems/clever-ruby/versions/1.2.4
240
- - https://github.com/Clever/clever-ruby/tree/v1.2.4
241
-
1172
+ - https://rubygems.org/gems/clever-ruby/versions/1.2.4
1173
+ - https://github.com/Clever/clever-ruby/tree/v1.2.4
242
1174
 
243
1175
  ## Updating the Library
244
1176
 
@@ -247,13 +1179,13 @@ The current client support v2.0 of the API. For v1.2 please use:
247
1179
  2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
248
1180
 
249
1181
  3. Run this command in the swagger-codegen repo
1182
+
250
1183
  ```
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
1184
+ swagger-codegen generate -i $PATH_TO_SWAGGER_API_REPO/full-v2.yml -l ruby -o $PATH_TO_THIS_REPO --additional-properties gemVersion=$VERSION
252
1185
  ```
253
1186
 
254
1187
  4. Run `make build` to copy over the override files
255
1188
 
256
-
257
1189
  ## Publishing
258
1190
 
259
1191
  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.