commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +37 -29
- data/README.md +994 -61
- data/clever-ruby.gemspec +6 -13
- data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
- data/commonlit-clever-ruby-2.1.6.beta2.gem +0 -0
- data/docs/AdminName.md +0 -1
- data/docs/BadRequest.md +0 -1
- data/docs/Contact.md +1 -2
- data/docs/ContactObject.md +0 -1
- data/docs/ContactResponse.md +0 -1
- data/docs/ContactsCreated.md +2 -3
- data/docs/ContactsDeleted.md +2 -3
- data/docs/ContactsResponse.md +0 -1
- data/docs/ContactsUpdated.md +2 -3
- data/docs/Course.md +1 -2
- data/docs/CourseObject.md +0 -1
- data/docs/CourseResponse.md +0 -1
- data/docs/CoursesCreated.md +2 -3
- data/docs/CoursesDeleted.md +2 -3
- data/docs/CoursesResponse.md +0 -1
- data/docs/CoursesUpdated.md +2 -3
- data/docs/Credentials.md +0 -1
- data/docs/DataApi.md +2784 -0
- data/docs/District.md +9 -10
- data/docs/DistrictAdmin.md +2 -3
- data/docs/DistrictAdminObject.md +0 -1
- data/docs/DistrictAdminResponse.md +0 -1
- data/docs/DistrictAdminsResponse.md +0 -1
- data/docs/DistrictObject.md +0 -1
- data/docs/DistrictResponse.md +0 -1
- data/docs/DistrictadminsCreated.md +2 -3
- data/docs/DistrictadminsDeleted.md +2 -3
- data/docs/DistrictadminsUpdated.md +2 -3
- data/docs/DistrictsCreated.md +2 -3
- data/docs/DistrictsDeleted.md +2 -3
- data/docs/DistrictsResponse.md +0 -1
- data/docs/DistrictsUpdated.md +2 -3
- data/docs/Event.md +2 -3
- data/docs/EventResponse.md +0 -1
- data/docs/EventsApi.md +1 -4
- data/docs/EventsResponse.md +0 -1
- data/docs/InternalError.md +0 -1
- data/docs/Link.md +0 -1
- data/docs/Location.md +2 -3
- data/docs/Name.md +1 -2
- data/docs/NotFound.md +0 -1
- data/docs/Principal.md +1 -2
- data/docs/School.md +3 -4
- data/docs/SchoolAdmin.md +3 -4
- data/docs/SchoolAdminObject.md +0 -1
- data/docs/SchoolAdminResponse.md +0 -1
- data/docs/SchoolAdminsResponse.md +0 -1
- data/docs/SchoolEnrollment.md +1 -2
- data/docs/SchoolObject.md +0 -1
- data/docs/SchoolResponse.md +0 -1
- data/docs/SchooladminsCreated.md +2 -3
- data/docs/SchooladminsDeleted.md +2 -3
- data/docs/SchooladminsUpdated.md +2 -3
- data/docs/SchoolsCreated.md +2 -3
- data/docs/SchoolsDeleted.md +2 -3
- data/docs/SchoolsResponse.md +0 -1
- data/docs/SchoolsUpdated.md +2 -3
- data/docs/Section.md +2 -3
- data/docs/SectionObject.md +0 -1
- data/docs/SectionResponse.md +0 -1
- data/docs/SectionsCreated.md +2 -3
- data/docs/SectionsDeleted.md +2 -3
- data/docs/SectionsResponse.md +0 -1
- data/docs/SectionsUpdated.md +2 -3
- data/docs/Student.md +3 -4
- data/docs/StudentObject.md +0 -1
- data/docs/StudentResponse.md +0 -1
- data/docs/StudentsCreated.md +2 -3
- data/docs/StudentsDeleted.md +2 -3
- data/docs/StudentsResponse.md +0 -1
- data/docs/StudentsUpdated.md +2 -3
- data/docs/Teacher.md +2 -3
- data/docs/TeacherObject.md +0 -1
- data/docs/TeacherResponse.md +0 -1
- data/docs/TeachersCreated.md +2 -3
- data/docs/TeachersDeleted.md +2 -3
- data/docs/TeachersResponse.md +0 -1
- data/docs/TeachersUpdated.md +2 -3
- data/docs/Term.md +2 -3
- data/docs/TermObject.md +0 -1
- data/docs/TermResponse.md +0 -1
- data/docs/TermsCreated.md +2 -3
- data/docs/TermsDeleted.md +2 -3
- data/docs/TermsResponse.md +0 -1
- data/docs/TermsUpdated.md +2 -3
- data/git_push.sh +55 -0
- data/lib/clever-ruby/api/data_api.rb +2999 -0
- data/lib/clever-ruby/api/events_api.rb +25 -20
- data/lib/clever-ruby/api_error.rb +23 -4
- data/lib/clever-ruby/configuration.rb +5 -9
- data/lib/clever-ruby/models/admin_name.rb +46 -22
- data/lib/clever-ruby/models/bad_request.rb +42 -20
- data/lib/clever-ruby/models/contact.rb +83 -55
- data/lib/clever-ruby/models/contact_object.rb +42 -20
- data/lib/clever-ruby/models/contact_response.rb +42 -20
- data/lib/clever-ruby/models/contacts_response.rb +44 -22
- data/lib/clever-ruby/models/course.rb +60 -36
- data/lib/clever-ruby/models/course_object.rb +42 -20
- data/lib/clever-ruby/models/course_response.rb +42 -20
- data/lib/clever-ruby/models/courses_response.rb +44 -22
- data/lib/clever-ruby/models/credentials.rb +42 -20
- data/lib/clever-ruby/models/district.rb +122 -94
- data/lib/clever-ruby/models/district_admin.rb +67 -44
- data/lib/clever-ruby/models/district_admin_object.rb +42 -20
- data/lib/clever-ruby/models/district_admin_response.rb +42 -20
- data/lib/clever-ruby/models/district_admins_response.rb +44 -22
- data/lib/clever-ruby/models/district_object.rb +42 -20
- data/lib/clever-ruby/models/district_response.rb +42 -20
- data/lib/clever-ruby/models/districts_response.rb +44 -22
- data/lib/clever-ruby/models/event.rb +60 -33
- data/lib/clever-ruby/models/event_response.rb +42 -20
- data/lib/clever-ruby/models/events_response.rb +44 -22
- data/lib/clever-ruby/models/internal_error.rb +42 -20
- data/lib/clever-ruby/models/link.rb +47 -25
- data/lib/clever-ruby/models/location.rb +73 -45
- data/lib/clever-ruby/models/name.rb +58 -33
- data/lib/clever-ruby/models/not_found.rb +42 -20
- data/lib/clever-ruby/models/principal.rb +55 -31
- data/lib/clever-ruby/models/school.rb +108 -80
- data/lib/clever-ruby/models/school_admin.rb +85 -61
- data/lib/clever-ruby/models/school_admin_object.rb +42 -20
- data/lib/clever-ruby/models/school_admin_response.rb +42 -20
- data/lib/clever-ruby/models/school_admins_response.rb +44 -22
- data/lib/clever-ruby/models/school_enrollment.rb +56 -34
- data/lib/clever-ruby/models/school_object.rb +42 -20
- data/lib/clever-ruby/models/school_response.rb +42 -20
- data/lib/clever-ruby/models/schools_response.rb +44 -22
- data/lib/clever-ruby/models/section.rb +104 -75
- data/lib/clever-ruby/models/section_object.rb +42 -20
- data/lib/clever-ruby/models/section_response.rb +42 -20
- data/lib/clever-ruby/models/sections_response.rb +44 -22
- data/lib/clever-ruby/models/student.rb +147 -126
- data/lib/clever-ruby/models/student_object.rb +42 -20
- data/lib/clever-ruby/models/student_response.rb +42 -20
- data/lib/clever-ruby/models/students_response.rb +44 -22
- data/lib/clever-ruby/models/teacher.rb +89 -63
- data/lib/clever-ruby/models/teacher_object.rb +42 -20
- data/lib/clever-ruby/models/teacher_response.rb +42 -20
- data/lib/clever-ruby/models/teachers_response.rb +44 -22
- data/lib/clever-ruby/models/term.rb +69 -44
- data/lib/clever-ruby/models/term_object.rb +42 -20
- data/lib/clever-ruby/models/term_response.rb +42 -20
- data/lib/clever-ruby/models/terms_response.rb +44 -22
- data/lib/clever-ruby/version.rb +4 -5
- data/lib/clever-ruby.rb +4 -14
- data/override/README-extension.md +1 -1
- data/override/override.sh +3 -0
- data/spec/api/data_api_spec.rb +671 -0
- data/spec/api/events_api_spec.rb +4 -3
- data/spec/api_client_spec.rb +21 -3
- data/spec/spec_helper.rb +4 -3
- metadata +27 -180
- data/docs/ContactsApi.md +0 -231
- data/docs/CoursesApi.md +0 -231
- data/docs/DistrictAdminsApi.md +0 -171
- data/docs/DistrictsApi.md +0 -113
- data/docs/SchoolAdminsApi.md +0 -231
- data/docs/SchoolsApi.md +0 -351
- data/docs/SectionsApi.md +0 -499
- data/docs/StudentsApi.md +0 -463
- data/docs/TeachersApi.md +0 -403
- data/docs/TermsApi.md +0 -231
- data/lib/clever-ruby/api/contacts_api.rb +0 -241
- data/lib/clever-ruby/api/courses_api.rb +0 -241
- data/lib/clever-ruby/api/district_admins_api.rb +0 -182
- data/lib/clever-ruby/api/districts_api.rb +0 -123
- data/lib/clever-ruby/api/school_admins_api.rb +0 -241
- data/lib/clever-ruby/api/schools_api.rb +0 -359
- data/lib/clever-ruby/api/sections_api.rb +0 -500
- data/lib/clever-ruby/api/students_api.rb +0 -468
- data/lib/clever-ruby/api/teachers_api.rb +0 -409
- data/lib/clever-ruby/api/terms_api.rb +0 -241
- data/spec/api/contacts_api_spec.rb +0 -84
- data/spec/api/courses_api_spec.rb +0 -84
- data/spec/api/district_admins_api_spec.rb +0 -70
- data/spec/api/districts_api_spec.rb +0 -56
- data/spec/api/school_admins_api_spec.rb +0 -84
- data/spec/api/schools_api_spec.rb +0 -112
- data/spec/api/sections_api_spec.rb +0 -142
- data/spec/api/students_api_spec.rb +0 -137
- data/spec/api/teachers_api_spec.rb +0 -123
- data/spec/api/terms_api_spec.rb +0 -84
data/docs/TeachersApi.md
DELETED
@@ -1,403 +0,0 @@
|
|
1
|
-
# Clever::TeachersApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.clever.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_district_for_teacher**](TeachersApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
8
|
-
[**get_school_for_teacher**](TeachersApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
|
9
|
-
[**get_schools_for_teacher**](TeachersApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
|
10
|
-
[**get_sections_for_teacher**](TeachersApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
|
11
|
-
[**get_students_for_teacher**](TeachersApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
|
12
|
-
[**get_teacher**](TeachersApi.md#get_teacher) | **GET** /teachers/{id} |
|
13
|
-
[**get_teachers**](TeachersApi.md#get_teachers) | **GET** /teachers |
|
14
|
-
|
15
|
-
|
16
|
-
# **get_district_for_teacher**
|
17
|
-
> DistrictResponse get_district_for_teacher(id)
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
Returns the district for a teacher
|
22
|
-
|
23
|
-
### Example
|
24
|
-
```ruby
|
25
|
-
# load the gem
|
26
|
-
require 'clever-ruby'
|
27
|
-
# setup authorization
|
28
|
-
Clever.configure do |config|
|
29
|
-
# Configure OAuth2 access token for authorization: oauth
|
30
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = Clever::TeachersApi.new
|
34
|
-
|
35
|
-
id = 'id_example' # String |
|
36
|
-
|
37
|
-
|
38
|
-
begin
|
39
|
-
result = api_instance.get_district_for_teacher(id)
|
40
|
-
p result
|
41
|
-
rescue Clever::ApiError => e
|
42
|
-
puts "Exception when calling TeachersApi->get_district_for_teacher: #{e}"
|
43
|
-
end
|
44
|
-
```
|
45
|
-
|
46
|
-
### Parameters
|
47
|
-
|
48
|
-
Name | Type | Description | Notes
|
49
|
-
------------- | ------------- | ------------- | -------------
|
50
|
-
**id** | **String**| |
|
51
|
-
|
52
|
-
### Return type
|
53
|
-
|
54
|
-
[**DistrictResponse**](DistrictResponse.md)
|
55
|
-
|
56
|
-
### Authorization
|
57
|
-
|
58
|
-
[oauth](../README.md#oauth)
|
59
|
-
|
60
|
-
### HTTP request headers
|
61
|
-
|
62
|
-
- **Content-Type**: Not defined
|
63
|
-
- **Accept**: application/json
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
# **get_school_for_teacher**
|
68
|
-
> SchoolResponse get_school_for_teacher(id)
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
Retrieves school info for a teacher.
|
73
|
-
|
74
|
-
### Example
|
75
|
-
```ruby
|
76
|
-
# load the gem
|
77
|
-
require 'clever-ruby'
|
78
|
-
# setup authorization
|
79
|
-
Clever.configure do |config|
|
80
|
-
# Configure OAuth2 access token for authorization: oauth
|
81
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
82
|
-
end
|
83
|
-
|
84
|
-
api_instance = Clever::TeachersApi.new
|
85
|
-
|
86
|
-
id = 'id_example' # String |
|
87
|
-
|
88
|
-
|
89
|
-
begin
|
90
|
-
result = api_instance.get_school_for_teacher(id)
|
91
|
-
p result
|
92
|
-
rescue Clever::ApiError => e
|
93
|
-
puts "Exception when calling TeachersApi->get_school_for_teacher: #{e}"
|
94
|
-
end
|
95
|
-
```
|
96
|
-
|
97
|
-
### Parameters
|
98
|
-
|
99
|
-
Name | Type | Description | Notes
|
100
|
-
------------- | ------------- | ------------- | -------------
|
101
|
-
**id** | **String**| |
|
102
|
-
|
103
|
-
### Return type
|
104
|
-
|
105
|
-
[**SchoolResponse**](SchoolResponse.md)
|
106
|
-
|
107
|
-
### Authorization
|
108
|
-
|
109
|
-
[oauth](../README.md#oauth)
|
110
|
-
|
111
|
-
### HTTP request headers
|
112
|
-
|
113
|
-
- **Content-Type**: Not defined
|
114
|
-
- **Accept**: application/json
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
# **get_schools_for_teacher**
|
119
|
-
> SchoolsResponse get_schools_for_teacher(id, opts)
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
Returns the schools for a teacher
|
124
|
-
|
125
|
-
### Example
|
126
|
-
```ruby
|
127
|
-
# load the gem
|
128
|
-
require 'clever-ruby'
|
129
|
-
# setup authorization
|
130
|
-
Clever.configure do |config|
|
131
|
-
# Configure OAuth2 access token for authorization: oauth
|
132
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
133
|
-
end
|
134
|
-
|
135
|
-
api_instance = Clever::TeachersApi.new
|
136
|
-
|
137
|
-
id = 'id_example' # String |
|
138
|
-
|
139
|
-
opts = {
|
140
|
-
limit: 56, # Integer |
|
141
|
-
starting_after: 'starting_after_example', # String |
|
142
|
-
ending_before: 'ending_before_example' # String |
|
143
|
-
}
|
144
|
-
|
145
|
-
begin
|
146
|
-
result = api_instance.get_schools_for_teacher(id, opts)
|
147
|
-
p result
|
148
|
-
rescue Clever::ApiError => e
|
149
|
-
puts "Exception when calling TeachersApi->get_schools_for_teacher: #{e}"
|
150
|
-
end
|
151
|
-
```
|
152
|
-
|
153
|
-
### Parameters
|
154
|
-
|
155
|
-
Name | Type | Description | Notes
|
156
|
-
------------- | ------------- | ------------- | -------------
|
157
|
-
**id** | **String**| |
|
158
|
-
**limit** | **Integer**| | [optional]
|
159
|
-
**starting_after** | **String**| | [optional]
|
160
|
-
**ending_before** | **String**| | [optional]
|
161
|
-
|
162
|
-
### Return type
|
163
|
-
|
164
|
-
[**SchoolsResponse**](SchoolsResponse.md)
|
165
|
-
|
166
|
-
### Authorization
|
167
|
-
|
168
|
-
[oauth](../README.md#oauth)
|
169
|
-
|
170
|
-
### HTTP request headers
|
171
|
-
|
172
|
-
- **Content-Type**: Not defined
|
173
|
-
- **Accept**: application/json
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
# **get_sections_for_teacher**
|
178
|
-
> SectionsResponse get_sections_for_teacher(id, opts)
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
Returns the sections for a teacher
|
183
|
-
|
184
|
-
### Example
|
185
|
-
```ruby
|
186
|
-
# load the gem
|
187
|
-
require 'clever-ruby'
|
188
|
-
# setup authorization
|
189
|
-
Clever.configure do |config|
|
190
|
-
# Configure OAuth2 access token for authorization: oauth
|
191
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
192
|
-
end
|
193
|
-
|
194
|
-
api_instance = Clever::TeachersApi.new
|
195
|
-
|
196
|
-
id = 'id_example' # String |
|
197
|
-
|
198
|
-
opts = {
|
199
|
-
limit: 56, # Integer |
|
200
|
-
starting_after: 'starting_after_example', # String |
|
201
|
-
ending_before: 'ending_before_example' # String |
|
202
|
-
}
|
203
|
-
|
204
|
-
begin
|
205
|
-
result = api_instance.get_sections_for_teacher(id, opts)
|
206
|
-
p result
|
207
|
-
rescue Clever::ApiError => e
|
208
|
-
puts "Exception when calling TeachersApi->get_sections_for_teacher: #{e}"
|
209
|
-
end
|
210
|
-
```
|
211
|
-
|
212
|
-
### Parameters
|
213
|
-
|
214
|
-
Name | Type | Description | Notes
|
215
|
-
------------- | ------------- | ------------- | -------------
|
216
|
-
**id** | **String**| |
|
217
|
-
**limit** | **Integer**| | [optional]
|
218
|
-
**starting_after** | **String**| | [optional]
|
219
|
-
**ending_before** | **String**| | [optional]
|
220
|
-
|
221
|
-
### Return type
|
222
|
-
|
223
|
-
[**SectionsResponse**](SectionsResponse.md)
|
224
|
-
|
225
|
-
### Authorization
|
226
|
-
|
227
|
-
[oauth](../README.md#oauth)
|
228
|
-
|
229
|
-
### HTTP request headers
|
230
|
-
|
231
|
-
- **Content-Type**: Not defined
|
232
|
-
- **Accept**: application/json
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
# **get_students_for_teacher**
|
237
|
-
> StudentsResponse get_students_for_teacher(id, opts)
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
Returns the students for a teacher
|
242
|
-
|
243
|
-
### Example
|
244
|
-
```ruby
|
245
|
-
# load the gem
|
246
|
-
require 'clever-ruby'
|
247
|
-
# setup authorization
|
248
|
-
Clever.configure do |config|
|
249
|
-
# Configure OAuth2 access token for authorization: oauth
|
250
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
251
|
-
end
|
252
|
-
|
253
|
-
api_instance = Clever::TeachersApi.new
|
254
|
-
|
255
|
-
id = 'id_example' # String |
|
256
|
-
|
257
|
-
opts = {
|
258
|
-
limit: 56, # Integer |
|
259
|
-
starting_after: 'starting_after_example', # String |
|
260
|
-
ending_before: 'ending_before_example' # String |
|
261
|
-
}
|
262
|
-
|
263
|
-
begin
|
264
|
-
result = api_instance.get_students_for_teacher(id, opts)
|
265
|
-
p result
|
266
|
-
rescue Clever::ApiError => e
|
267
|
-
puts "Exception when calling TeachersApi->get_students_for_teacher: #{e}"
|
268
|
-
end
|
269
|
-
```
|
270
|
-
|
271
|
-
### Parameters
|
272
|
-
|
273
|
-
Name | Type | Description | Notes
|
274
|
-
------------- | ------------- | ------------- | -------------
|
275
|
-
**id** | **String**| |
|
276
|
-
**limit** | **Integer**| | [optional]
|
277
|
-
**starting_after** | **String**| | [optional]
|
278
|
-
**ending_before** | **String**| | [optional]
|
279
|
-
|
280
|
-
### Return type
|
281
|
-
|
282
|
-
[**StudentsResponse**](StudentsResponse.md)
|
283
|
-
|
284
|
-
### Authorization
|
285
|
-
|
286
|
-
[oauth](../README.md#oauth)
|
287
|
-
|
288
|
-
### HTTP request headers
|
289
|
-
|
290
|
-
- **Content-Type**: Not defined
|
291
|
-
- **Accept**: application/json
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
# **get_teacher**
|
296
|
-
> TeacherResponse get_teacher(id)
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
Returns a specific teacher
|
301
|
-
|
302
|
-
### Example
|
303
|
-
```ruby
|
304
|
-
# load the gem
|
305
|
-
require 'clever-ruby'
|
306
|
-
# setup authorization
|
307
|
-
Clever.configure do |config|
|
308
|
-
# Configure OAuth2 access token for authorization: oauth
|
309
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
310
|
-
end
|
311
|
-
|
312
|
-
api_instance = Clever::TeachersApi.new
|
313
|
-
|
314
|
-
id = 'id_example' # String |
|
315
|
-
|
316
|
-
|
317
|
-
begin
|
318
|
-
result = api_instance.get_teacher(id)
|
319
|
-
p result
|
320
|
-
rescue Clever::ApiError => e
|
321
|
-
puts "Exception when calling TeachersApi->get_teacher: #{e}"
|
322
|
-
end
|
323
|
-
```
|
324
|
-
|
325
|
-
### Parameters
|
326
|
-
|
327
|
-
Name | Type | Description | Notes
|
328
|
-
------------- | ------------- | ------------- | -------------
|
329
|
-
**id** | **String**| |
|
330
|
-
|
331
|
-
### Return type
|
332
|
-
|
333
|
-
[**TeacherResponse**](TeacherResponse.md)
|
334
|
-
|
335
|
-
### Authorization
|
336
|
-
|
337
|
-
[oauth](../README.md#oauth)
|
338
|
-
|
339
|
-
### HTTP request headers
|
340
|
-
|
341
|
-
- **Content-Type**: Not defined
|
342
|
-
- **Accept**: application/json
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
# **get_teachers**
|
347
|
-
> TeachersResponse get_teachers(opts)
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
Returns a list of teachers
|
352
|
-
|
353
|
-
### Example
|
354
|
-
```ruby
|
355
|
-
# load the gem
|
356
|
-
require 'clever-ruby'
|
357
|
-
# setup authorization
|
358
|
-
Clever.configure do |config|
|
359
|
-
# Configure OAuth2 access token for authorization: oauth
|
360
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
361
|
-
end
|
362
|
-
|
363
|
-
api_instance = Clever::TeachersApi.new
|
364
|
-
|
365
|
-
opts = {
|
366
|
-
limit: 56, # Integer |
|
367
|
-
starting_after: 'starting_after_example', # String |
|
368
|
-
ending_before: 'ending_before_example', # String |
|
369
|
-
count: 'count_example' # String |
|
370
|
-
}
|
371
|
-
|
372
|
-
begin
|
373
|
-
result = api_instance.get_teachers(opts)
|
374
|
-
p result
|
375
|
-
rescue Clever::ApiError => e
|
376
|
-
puts "Exception when calling TeachersApi->get_teachers: #{e}"
|
377
|
-
end
|
378
|
-
```
|
379
|
-
|
380
|
-
### Parameters
|
381
|
-
|
382
|
-
Name | Type | Description | Notes
|
383
|
-
------------- | ------------- | ------------- | -------------
|
384
|
-
**limit** | **Integer**| | [optional]
|
385
|
-
**starting_after** | **String**| | [optional]
|
386
|
-
**ending_before** | **String**| | [optional]
|
387
|
-
**count** | **String**| | [optional]
|
388
|
-
|
389
|
-
### Return type
|
390
|
-
|
391
|
-
[**TeachersResponse**](TeachersResponse.md)
|
392
|
-
|
393
|
-
### Authorization
|
394
|
-
|
395
|
-
[oauth](../README.md#oauth)
|
396
|
-
|
397
|
-
### HTTP request headers
|
398
|
-
|
399
|
-
- **Content-Type**: Not defined
|
400
|
-
- **Accept**: application/json
|
401
|
-
|
402
|
-
|
403
|
-
|
data/docs/TermsApi.md
DELETED
@@ -1,231 +0,0 @@
|
|
1
|
-
# Clever::TermsApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.clever.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_district_for_term**](TermsApi.md#get_district_for_term) | **GET** /terms/{id}/district |
|
8
|
-
[**get_sections_for_term**](TermsApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
|
9
|
-
[**get_term**](TermsApi.md#get_term) | **GET** /terms/{id} |
|
10
|
-
[**get_terms**](TermsApi.md#get_terms) | **GET** /terms |
|
11
|
-
|
12
|
-
|
13
|
-
# **get_district_for_term**
|
14
|
-
> DistrictResponse get_district_for_term(id)
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
Returns the district for a term
|
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::TermsApi.new
|
31
|
-
|
32
|
-
id = 'id_example' # String |
|
33
|
-
|
34
|
-
|
35
|
-
begin
|
36
|
-
result = api_instance.get_district_for_term(id)
|
37
|
-
p result
|
38
|
-
rescue Clever::ApiError => e
|
39
|
-
puts "Exception when calling TermsApi->get_district_for_term: #{e}"
|
40
|
-
end
|
41
|
-
```
|
42
|
-
|
43
|
-
### Parameters
|
44
|
-
|
45
|
-
Name | Type | Description | Notes
|
46
|
-
------------- | ------------- | ------------- | -------------
|
47
|
-
**id** | **String**| |
|
48
|
-
|
49
|
-
### Return type
|
50
|
-
|
51
|
-
[**DistrictResponse**](DistrictResponse.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_sections_for_term**
|
65
|
-
> SectionsResponse get_sections_for_term(id, opts)
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
Returns the sections for a term
|
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::TermsApi.new
|
82
|
-
|
83
|
-
id = 'id_example' # String |
|
84
|
-
|
85
|
-
opts = {
|
86
|
-
limit: 56, # Integer |
|
87
|
-
starting_after: 'starting_after_example', # String |
|
88
|
-
ending_before: 'ending_before_example' # String |
|
89
|
-
}
|
90
|
-
|
91
|
-
begin
|
92
|
-
result = api_instance.get_sections_for_term(id, opts)
|
93
|
-
p result
|
94
|
-
rescue Clever::ApiError => e
|
95
|
-
puts "Exception when calling TermsApi->get_sections_for_term: #{e}"
|
96
|
-
end
|
97
|
-
```
|
98
|
-
|
99
|
-
### Parameters
|
100
|
-
|
101
|
-
Name | Type | Description | Notes
|
102
|
-
------------- | ------------- | ------------- | -------------
|
103
|
-
**id** | **String**| |
|
104
|
-
**limit** | **Integer**| | [optional]
|
105
|
-
**starting_after** | **String**| | [optional]
|
106
|
-
**ending_before** | **String**| | [optional]
|
107
|
-
|
108
|
-
### Return type
|
109
|
-
|
110
|
-
[**SectionsResponse**](SectionsResponse.md)
|
111
|
-
|
112
|
-
### Authorization
|
113
|
-
|
114
|
-
[oauth](../README.md#oauth)
|
115
|
-
|
116
|
-
### HTTP request headers
|
117
|
-
|
118
|
-
- **Content-Type**: Not defined
|
119
|
-
- **Accept**: application/json
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
# **get_term**
|
124
|
-
> TermResponse get_term(id)
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
Returns a specific term
|
129
|
-
|
130
|
-
### Example
|
131
|
-
```ruby
|
132
|
-
# load the gem
|
133
|
-
require 'clever-ruby'
|
134
|
-
# setup authorization
|
135
|
-
Clever.configure do |config|
|
136
|
-
# Configure OAuth2 access token for authorization: oauth
|
137
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
138
|
-
end
|
139
|
-
|
140
|
-
api_instance = Clever::TermsApi.new
|
141
|
-
|
142
|
-
id = 'id_example' # String |
|
143
|
-
|
144
|
-
|
145
|
-
begin
|
146
|
-
result = api_instance.get_term(id)
|
147
|
-
p result
|
148
|
-
rescue Clever::ApiError => e
|
149
|
-
puts "Exception when calling TermsApi->get_term: #{e}"
|
150
|
-
end
|
151
|
-
```
|
152
|
-
|
153
|
-
### Parameters
|
154
|
-
|
155
|
-
Name | Type | Description | Notes
|
156
|
-
------------- | ------------- | ------------- | -------------
|
157
|
-
**id** | **String**| |
|
158
|
-
|
159
|
-
### Return type
|
160
|
-
|
161
|
-
[**TermResponse**](TermResponse.md)
|
162
|
-
|
163
|
-
### Authorization
|
164
|
-
|
165
|
-
[oauth](../README.md#oauth)
|
166
|
-
|
167
|
-
### HTTP request headers
|
168
|
-
|
169
|
-
- **Content-Type**: Not defined
|
170
|
-
- **Accept**: application/json
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
# **get_terms**
|
175
|
-
> TermsResponse get_terms(opts)
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
Returns a list of terms
|
180
|
-
|
181
|
-
### Example
|
182
|
-
```ruby
|
183
|
-
# load the gem
|
184
|
-
require 'clever-ruby'
|
185
|
-
# setup authorization
|
186
|
-
Clever.configure do |config|
|
187
|
-
# Configure OAuth2 access token for authorization: oauth
|
188
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
189
|
-
end
|
190
|
-
|
191
|
-
api_instance = Clever::TermsApi.new
|
192
|
-
|
193
|
-
opts = {
|
194
|
-
limit: 56, # Integer |
|
195
|
-
starting_after: 'starting_after_example', # String |
|
196
|
-
ending_before: 'ending_before_example', # String |
|
197
|
-
count: 'count_example' # String |
|
198
|
-
}
|
199
|
-
|
200
|
-
begin
|
201
|
-
result = api_instance.get_terms(opts)
|
202
|
-
p result
|
203
|
-
rescue Clever::ApiError => e
|
204
|
-
puts "Exception when calling TermsApi->get_terms: #{e}"
|
205
|
-
end
|
206
|
-
```
|
207
|
-
|
208
|
-
### Parameters
|
209
|
-
|
210
|
-
Name | Type | Description | Notes
|
211
|
-
------------- | ------------- | ------------- | -------------
|
212
|
-
**limit** | **Integer**| | [optional]
|
213
|
-
**starting_after** | **String**| | [optional]
|
214
|
-
**ending_before** | **String**| | [optional]
|
215
|
-
**count** | **String**| | [optional]
|
216
|
-
|
217
|
-
### Return type
|
218
|
-
|
219
|
-
[**TermsResponse**](TermsResponse.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
|
-
|