clever-ruby 1.2.5 → 2.0.0
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.
- checksums.yaml +4 -4
- data/1.8, +0 -0
- data/= +0 -0
- data/CHANGELOG.md +3 -3
- data/Gemfile +0 -1
- data/Gemfile.lock +8 -9
- data/README.md +89 -70
- data/clever-ruby.gemspec +3 -4
- data/doc_coverage.txt +2 -0
- data/docs/{StudentContact.md → Contact.md} +2 -2
- data/docs/{GradeLevelsResponse.md → ContactObject.md} +2 -2
- data/docs/{StudentContactObject.md → ContactResponse.md} +2 -2
- data/docs/{StudentcontactsCreated.md → ContactsCreated.md} +2 -2
- data/docs/{StudentcontactsDeleted.md → ContactsDeleted.md} +2 -2
- data/docs/ContactsResponse.md +8 -0
- data/docs/{StudentcontactsUpdated.md → ContactsUpdated.md} +2 -2
- data/docs/Course.md +10 -0
- data/docs/{StudentContactResponse.md → CourseObject.md} +2 -2
- data/docs/CourseResponse.md +8 -0
- data/docs/CoursesCreated.md +11 -0
- data/docs/CoursesDeleted.md +11 -0
- data/docs/{StudentContactsForStudentResponse.md → CoursesResponse.md} +2 -2
- data/docs/CoursesUpdated.md +11 -0
- data/docs/DataApi.md +862 -182
- data/docs/District.md +8 -0
- data/docs/{DistrictStatusResponse.md → DistrictAdminObject.md} +2 -2
- data/docs/DistrictAdminsResponse.md +1 -1
- data/docs/DistrictadminsCreated.md +11 -0
- data/docs/DistrictadminsDeleted.md +11 -0
- data/docs/DistrictadminsUpdated.md +11 -0
- data/docs/EventsApi.md +6 -302
- data/docs/Section.md +2 -4
- data/docs/Term.md +1 -0
- data/docs/TermObject.md +8 -0
- data/docs/TermResponse.md +8 -0
- data/docs/TermsCreated.md +11 -0
- data/docs/TermsDeleted.md +11 -0
- data/docs/TermsResponse.md +8 -0
- data/docs/TermsUpdated.md +11 -0
- data/lib/clever-ruby.rb +26 -14
- data/lib/clever-ruby/api/data_api.rb +828 -132
- data/lib/clever-ruby/api/events_api.rb +8 -312
- data/lib/clever-ruby/api_client.rb +40 -27
- data/lib/clever-ruby/api_error.rb +2 -2
- data/lib/clever-ruby/configuration.rb +3 -3
- data/lib/clever-ruby/models/bad_request.rb +2 -2
- data/lib/clever-ruby/models/{student_contact.rb → contact.rb} +69 -10
- data/lib/clever-ruby/models/{student_contact_object.rb → contact_object.rb} +4 -4
- data/lib/clever-ruby/models/{student_contact_response.rb → contact_response.rb} +4 -4
- data/lib/clever-ruby/models/contacts_created.rb +221 -0
- data/lib/clever-ruby/models/contacts_deleted.rb +221 -0
- data/lib/clever-ruby/models/{student_contacts_response.rb → contacts_response.rb} +4 -4
- data/lib/clever-ruby/models/contacts_updated.rb +221 -0
- data/lib/clever-ruby/models/course.rb +206 -0
- data/lib/clever-ruby/models/course_object.rb +188 -0
- data/lib/clever-ruby/models/{district_status_response.rb → course_response.rb} +4 -4
- data/lib/clever-ruby/models/courses_created.rb +221 -0
- data/lib/clever-ruby/models/courses_deleted.rb +221 -0
- data/lib/clever-ruby/models/{district_status_responses.rb → courses_response.rb} +4 -4
- data/lib/clever-ruby/models/courses_updated.rb +221 -0
- data/lib/clever-ruby/models/credentials.rb +2 -2
- data/lib/clever-ruby/models/district.rb +111 -6
- data/lib/clever-ruby/models/district_admin.rb +2 -2
- data/lib/clever-ruby/models/district_admin_object.rb +188 -0
- data/lib/clever-ruby/models/district_admin_response.rb +2 -2
- data/lib/clever-ruby/models/district_admins_response.rb +3 -3
- data/lib/clever-ruby/models/district_object.rb +2 -2
- data/lib/clever-ruby/models/district_response.rb +2 -2
- data/lib/clever-ruby/models/districtadmins_created.rb +221 -0
- data/lib/clever-ruby/models/districtadmins_deleted.rb +221 -0
- data/lib/clever-ruby/models/districtadmins_updated.rb +221 -0
- data/lib/clever-ruby/models/districts_created.rb +22 -7
- data/lib/clever-ruby/models/districts_deleted.rb +22 -8
- data/lib/clever-ruby/models/districts_response.rb +2 -2
- data/lib/clever-ruby/models/districts_updated.rb +21 -7
- data/lib/clever-ruby/models/event.rb +2 -2
- data/lib/clever-ruby/models/event_response.rb +2 -2
- data/lib/clever-ruby/models/events_response.rb +2 -2
- data/lib/clever-ruby/models/internal_error.rb +2 -2
- data/lib/clever-ruby/models/location.rb +2 -2
- data/lib/clever-ruby/models/name.rb +2 -2
- data/lib/clever-ruby/models/not_found.rb +2 -2
- data/lib/clever-ruby/models/principal.rb +2 -2
- data/lib/clever-ruby/models/school.rb +2 -2
- data/lib/clever-ruby/models/school_admin.rb +2 -2
- data/lib/clever-ruby/models/school_admin_object.rb +2 -2
- data/lib/clever-ruby/models/school_admin_response.rb +2 -2
- data/lib/clever-ruby/models/school_admins_response.rb +2 -2
- data/lib/clever-ruby/models/school_object.rb +2 -2
- data/lib/clever-ruby/models/school_response.rb +2 -2
- data/lib/clever-ruby/models/schooladmins_created.rb +21 -7
- data/lib/clever-ruby/models/schooladmins_deleted.rb +21 -7
- data/lib/clever-ruby/models/schooladmins_updated.rb +21 -7
- data/lib/clever-ruby/models/schools_created.rb +21 -7
- data/lib/clever-ruby/models/schools_deleted.rb +21 -7
- data/lib/clever-ruby/models/schools_response.rb +2 -2
- data/lib/clever-ruby/models/schools_updated.rb +21 -7
- data/lib/clever-ruby/models/section.rb +15 -33
- data/lib/clever-ruby/models/section_object.rb +2 -2
- data/lib/clever-ruby/models/section_response.rb +2 -2
- data/lib/clever-ruby/models/sections_created.rb +21 -7
- data/lib/clever-ruby/models/sections_deleted.rb +21 -7
- data/lib/clever-ruby/models/sections_response.rb +2 -2
- data/lib/clever-ruby/models/sections_updated.rb +21 -7
- data/lib/clever-ruby/models/student.rb +4 -4
- data/lib/clever-ruby/models/student_object.rb +2 -2
- data/lib/clever-ruby/models/student_response.rb +2 -2
- data/lib/clever-ruby/models/students_created.rb +20 -7
- data/lib/clever-ruby/models/students_deleted.rb +22 -7
- data/lib/clever-ruby/models/students_response.rb +2 -2
- data/lib/clever-ruby/models/students_updated.rb +21 -7
- data/lib/clever-ruby/models/teacher.rb +2 -2
- data/lib/clever-ruby/models/teacher_object.rb +2 -2
- data/lib/clever-ruby/models/teacher_response.rb +2 -2
- data/lib/clever-ruby/models/teachers_created.rb +21 -7
- data/lib/clever-ruby/models/teachers_deleted.rb +21 -7
- data/lib/clever-ruby/models/teachers_response.rb +2 -2
- data/lib/clever-ruby/models/teachers_updated.rb +21 -7
- data/lib/clever-ruby/models/term.rb +12 -3
- data/lib/clever-ruby/models/term_object.rb +188 -0
- data/lib/clever-ruby/models/term_response.rb +188 -0
- data/lib/clever-ruby/models/{studentcontacts_updated.rb → terms_created.rb} +23 -9
- data/{override/models/studentcontacts_created.rb → lib/clever-ruby/models/terms_deleted.rb} +23 -9
- data/lib/clever-ruby/models/{grade_levels_response.rb → terms_response.rb} +4 -4
- data/lib/clever-ruby/models/{studentcontacts_created.rb → terms_updated.rb} +23 -9
- data/lib/clever-ruby/version.rb +3 -3
- data/override/README-extension.md +5 -5
- data/override/api_client.rb +40 -27
- data/override/models/contacts_created.rb +221 -0
- data/override/models/contacts_deleted.rb +221 -0
- data/override/models/contacts_updated.rb +221 -0
- data/override/models/courses_created.rb +221 -0
- data/override/models/courses_deleted.rb +221 -0
- data/override/models/courses_updated.rb +221 -0
- data/override/models/districtadmins_created.rb +221 -0
- data/override/models/districtadmins_deleted.rb +221 -0
- data/override/models/districtadmins_updated.rb +221 -0
- data/override/models/districts_created.rb +22 -7
- data/override/models/districts_deleted.rb +22 -8
- data/override/models/districts_updated.rb +21 -7
- data/override/models/schooladmins_created.rb +21 -7
- data/override/models/schooladmins_deleted.rb +21 -7
- data/override/models/schooladmins_updated.rb +21 -7
- data/override/models/schools_created.rb +21 -7
- data/override/models/schools_deleted.rb +21 -7
- data/override/models/schools_updated.rb +21 -7
- data/override/models/sections_created.rb +21 -7
- data/override/models/sections_deleted.rb +21 -7
- data/override/models/sections_updated.rb +21 -7
- data/override/models/students_created.rb +20 -7
- data/override/models/students_deleted.rb +22 -7
- data/override/models/students_updated.rb +21 -7
- data/override/models/teachers_created.rb +21 -7
- data/override/models/teachers_deleted.rb +21 -7
- data/override/models/teachers_updated.rb +21 -7
- data/{lib/clever-ruby/models/studentcontacts_deleted.rb → override/models/terms_created.rb} +23 -9
- data/override/models/terms_deleted.rb +221 -0
- data/override/models/terms_updated.rb +221 -0
- data/sample/sample.rb +2 -2
- data/spec/events_api_spec.rb +1 -1
- data/test.rb +1 -1
- metadata +111 -85
- data/clever-ruby-2.0.0.gem +0 -0
- data/docs/DistrictStatus.md +0 -15
- data/docs/DistrictStatusResponses.md +0 -8
- data/docs/StudentContactsResponse.md +0 -8
- data/lib/clever-ruby/models/district_status.rb +0 -284
- data/lib/clever-ruby/models/student_contacts_for_student_response.rb +0 -190
- data/override/models/studentcontacts_deleted.rb +0 -207
- data/override/models/studentcontacts_updated.rb +0 -207
- data/spec/data_api_spec.rb +0 -32
data/docs/District.md
CHANGED
@@ -3,8 +3,16 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | **String** | | [optional]
|
6
7
|
**id** | **String** | | [optional]
|
8
|
+
**last_sync** | **String** | | [optional]
|
9
|
+
**launch_date** | **String** | | [optional]
|
7
10
|
**mdr_number** | **String** | | [optional]
|
8
11
|
**name** | **String** | | [optional]
|
12
|
+
**nces_id** | **String** | | [optional]
|
13
|
+
**pause_end** | **String** | | [optional]
|
14
|
+
**pause_start** | **String** | | [optional]
|
15
|
+
**sis_type** | **String** | | [optional]
|
16
|
+
**state** | **String** | | [optional]
|
9
17
|
|
10
18
|
|
@@ -1,8 +1,8 @@
|
|
1
|
-
# Clever::
|
1
|
+
# Clever::DistrictAdminObject
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**object** | [**DistrictAdmin**](DistrictAdmin.md) | | [optional]
|
7
7
|
|
8
8
|
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<
|
6
|
+
**data** | [**Array<DistrictAdminResponse>**](DistrictAdminResponse.md) | | [optional]
|
7
7
|
|
8
8
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::DistrictadminsCreated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**DistrictAdminObject**](DistrictAdminObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::DistrictadminsDeleted
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**DistrictAdminObject**](DistrictAdminObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::DistrictadminsUpdated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**DistrictAdminObject**](DistrictAdminObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/EventsApi.md
CHANGED
@@ -1,16 +1,11 @@
|
|
1
1
|
# Clever::EventsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.clever.com/
|
3
|
+
All URIs are relative to *https://api.clever.com/v2.0*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_event**](EventsApi.md#get_event) | **GET** /events/{id} |
|
8
8
|
[**get_events**](EventsApi.md#get_events) | **GET** /events |
|
9
|
-
[**get_events_for_school**](EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events |
|
10
|
-
[**get_events_for_school_admin**](EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events |
|
11
|
-
[**get_events_for_section**](EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events |
|
12
|
-
[**get_events_for_student**](EventsApi.md#get_events_for_student) | **GET** /students/{id}/events |
|
13
|
-
[**get_events_for_teacher**](EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events |
|
14
9
|
|
15
10
|
|
16
11
|
# **get_event**
|
@@ -86,7 +81,9 @@ api_instance = Clever::EventsApi.new
|
|
86
81
|
opts = {
|
87
82
|
limit: 56, # Integer |
|
88
83
|
starting_after: "starting_after_example", # String |
|
89
|
-
ending_before: "ending_before_example" # String |
|
84
|
+
ending_before: "ending_before_example", # String |
|
85
|
+
school: "school_example", # String |
|
86
|
+
record_type: ["record_type_example"] # Array<String> |
|
90
87
|
}
|
91
88
|
|
92
89
|
begin
|
@@ -104,301 +101,8 @@ Name | Type | Description | Notes
|
|
104
101
|
**limit** | **Integer**| | [optional]
|
105
102
|
**starting_after** | **String**| | [optional]
|
106
103
|
**ending_before** | **String**| | [optional]
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
[**EventsResponse**](EventsResponse.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_events_for_school**
|
124
|
-
> EventsResponse get_events_for_school(id, opts)
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
Returns a list of events for a school
|
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::EventsApi.new
|
141
|
-
|
142
|
-
id = "id_example" # String |
|
143
|
-
|
144
|
-
opts = {
|
145
|
-
limit: 56, # Integer |
|
146
|
-
starting_after: "starting_after_example", # String |
|
147
|
-
ending_before: "ending_before_example" # String |
|
148
|
-
}
|
149
|
-
|
150
|
-
begin
|
151
|
-
result = api_instance.get_events_for_school(id, opts)
|
152
|
-
p result
|
153
|
-
rescue Clever::ApiError => e
|
154
|
-
puts "Exception when calling EventsApi->get_events_for_school: #{e}"
|
155
|
-
end
|
156
|
-
```
|
157
|
-
|
158
|
-
### Parameters
|
159
|
-
|
160
|
-
Name | Type | Description | Notes
|
161
|
-
------------- | ------------- | ------------- | -------------
|
162
|
-
**id** | **String**| |
|
163
|
-
**limit** | **Integer**| | [optional]
|
164
|
-
**starting_after** | **String**| | [optional]
|
165
|
-
**ending_before** | **String**| | [optional]
|
166
|
-
|
167
|
-
### Return type
|
168
|
-
|
169
|
-
[**EventsResponse**](EventsResponse.md)
|
170
|
-
|
171
|
-
### Authorization
|
172
|
-
|
173
|
-
[oauth](../README.md#oauth)
|
174
|
-
|
175
|
-
### HTTP request headers
|
176
|
-
|
177
|
-
- **Content-Type**: Not defined
|
178
|
-
- **Accept**: application/json
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
# **get_events_for_school_admin**
|
183
|
-
> EventsResponse get_events_for_school_admin(id, opts)
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
Returns a list of events for a school admin
|
188
|
-
|
189
|
-
### Example
|
190
|
-
```ruby
|
191
|
-
# load the gem
|
192
|
-
require 'clever-ruby'
|
193
|
-
# setup authorization
|
194
|
-
Clever.configure do |config|
|
195
|
-
# Configure OAuth2 access token for authorization: oauth
|
196
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
197
|
-
end
|
198
|
-
|
199
|
-
api_instance = Clever::EventsApi.new
|
200
|
-
|
201
|
-
id = "id_example" # String |
|
202
|
-
|
203
|
-
opts = {
|
204
|
-
limit: 56, # Integer |
|
205
|
-
starting_after: "starting_after_example", # String |
|
206
|
-
ending_before: "ending_before_example" # String |
|
207
|
-
}
|
208
|
-
|
209
|
-
begin
|
210
|
-
result = api_instance.get_events_for_school_admin(id, opts)
|
211
|
-
p result
|
212
|
-
rescue Clever::ApiError => e
|
213
|
-
puts "Exception when calling EventsApi->get_events_for_school_admin: #{e}"
|
214
|
-
end
|
215
|
-
```
|
216
|
-
|
217
|
-
### Parameters
|
218
|
-
|
219
|
-
Name | Type | Description | Notes
|
220
|
-
------------- | ------------- | ------------- | -------------
|
221
|
-
**id** | **String**| |
|
222
|
-
**limit** | **Integer**| | [optional]
|
223
|
-
**starting_after** | **String**| | [optional]
|
224
|
-
**ending_before** | **String**| | [optional]
|
225
|
-
|
226
|
-
### Return type
|
227
|
-
|
228
|
-
[**EventsResponse**](EventsResponse.md)
|
229
|
-
|
230
|
-
### Authorization
|
231
|
-
|
232
|
-
[oauth](../README.md#oauth)
|
233
|
-
|
234
|
-
### HTTP request headers
|
235
|
-
|
236
|
-
- **Content-Type**: Not defined
|
237
|
-
- **Accept**: application/json
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
# **get_events_for_section**
|
242
|
-
> EventsResponse get_events_for_section(id, opts)
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
Returns a list of events for a section
|
247
|
-
|
248
|
-
### Example
|
249
|
-
```ruby
|
250
|
-
# load the gem
|
251
|
-
require 'clever-ruby'
|
252
|
-
# setup authorization
|
253
|
-
Clever.configure do |config|
|
254
|
-
# Configure OAuth2 access token for authorization: oauth
|
255
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
256
|
-
end
|
257
|
-
|
258
|
-
api_instance = Clever::EventsApi.new
|
259
|
-
|
260
|
-
id = "id_example" # String |
|
261
|
-
|
262
|
-
opts = {
|
263
|
-
limit: 56, # Integer |
|
264
|
-
starting_after: "starting_after_example", # String |
|
265
|
-
ending_before: "ending_before_example" # String |
|
266
|
-
}
|
267
|
-
|
268
|
-
begin
|
269
|
-
result = api_instance.get_events_for_section(id, opts)
|
270
|
-
p result
|
271
|
-
rescue Clever::ApiError => e
|
272
|
-
puts "Exception when calling EventsApi->get_events_for_section: #{e}"
|
273
|
-
end
|
274
|
-
```
|
275
|
-
|
276
|
-
### Parameters
|
277
|
-
|
278
|
-
Name | Type | Description | Notes
|
279
|
-
------------- | ------------- | ------------- | -------------
|
280
|
-
**id** | **String**| |
|
281
|
-
**limit** | **Integer**| | [optional]
|
282
|
-
**starting_after** | **String**| | [optional]
|
283
|
-
**ending_before** | **String**| | [optional]
|
284
|
-
|
285
|
-
### Return type
|
286
|
-
|
287
|
-
[**EventsResponse**](EventsResponse.md)
|
288
|
-
|
289
|
-
### Authorization
|
290
|
-
|
291
|
-
[oauth](../README.md#oauth)
|
292
|
-
|
293
|
-
### HTTP request headers
|
294
|
-
|
295
|
-
- **Content-Type**: Not defined
|
296
|
-
- **Accept**: application/json
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
# **get_events_for_student**
|
301
|
-
> EventsResponse get_events_for_student(id, opts)
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
Returns a list of events for a student
|
306
|
-
|
307
|
-
### Example
|
308
|
-
```ruby
|
309
|
-
# load the gem
|
310
|
-
require 'clever-ruby'
|
311
|
-
# setup authorization
|
312
|
-
Clever.configure do |config|
|
313
|
-
# Configure OAuth2 access token for authorization: oauth
|
314
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
315
|
-
end
|
316
|
-
|
317
|
-
api_instance = Clever::EventsApi.new
|
318
|
-
|
319
|
-
id = "id_example" # String |
|
320
|
-
|
321
|
-
opts = {
|
322
|
-
limit: 56, # Integer |
|
323
|
-
starting_after: "starting_after_example", # String |
|
324
|
-
ending_before: "ending_before_example" # String |
|
325
|
-
}
|
326
|
-
|
327
|
-
begin
|
328
|
-
result = api_instance.get_events_for_student(id, opts)
|
329
|
-
p result
|
330
|
-
rescue Clever::ApiError => e
|
331
|
-
puts "Exception when calling EventsApi->get_events_for_student: #{e}"
|
332
|
-
end
|
333
|
-
```
|
334
|
-
|
335
|
-
### Parameters
|
336
|
-
|
337
|
-
Name | Type | Description | Notes
|
338
|
-
------------- | ------------- | ------------- | -------------
|
339
|
-
**id** | **String**| |
|
340
|
-
**limit** | **Integer**| | [optional]
|
341
|
-
**starting_after** | **String**| | [optional]
|
342
|
-
**ending_before** | **String**| | [optional]
|
343
|
-
|
344
|
-
### Return type
|
345
|
-
|
346
|
-
[**EventsResponse**](EventsResponse.md)
|
347
|
-
|
348
|
-
### Authorization
|
349
|
-
|
350
|
-
[oauth](../README.md#oauth)
|
351
|
-
|
352
|
-
### HTTP request headers
|
353
|
-
|
354
|
-
- **Content-Type**: Not defined
|
355
|
-
- **Accept**: application/json
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
# **get_events_for_teacher**
|
360
|
-
> EventsResponse get_events_for_teacher(id, opts)
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
Returns a list of events for a teacher
|
365
|
-
|
366
|
-
### Example
|
367
|
-
```ruby
|
368
|
-
# load the gem
|
369
|
-
require 'clever-ruby'
|
370
|
-
# setup authorization
|
371
|
-
Clever.configure do |config|
|
372
|
-
# Configure OAuth2 access token for authorization: oauth
|
373
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
374
|
-
end
|
375
|
-
|
376
|
-
api_instance = Clever::EventsApi.new
|
377
|
-
|
378
|
-
id = "id_example" # String |
|
379
|
-
|
380
|
-
opts = {
|
381
|
-
limit: 56, # Integer |
|
382
|
-
starting_after: "starting_after_example", # String |
|
383
|
-
ending_before: "ending_before_example" # String |
|
384
|
-
}
|
385
|
-
|
386
|
-
begin
|
387
|
-
result = api_instance.get_events_for_teacher(id, opts)
|
388
|
-
p result
|
389
|
-
rescue Clever::ApiError => e
|
390
|
-
puts "Exception when calling EventsApi->get_events_for_teacher: #{e}"
|
391
|
-
end
|
392
|
-
```
|
393
|
-
|
394
|
-
### Parameters
|
395
|
-
|
396
|
-
Name | Type | Description | Notes
|
397
|
-
------------- | ------------- | ------------- | -------------
|
398
|
-
**id** | **String**| |
|
399
|
-
**limit** | **Integer**| | [optional]
|
400
|
-
**starting_after** | **String**| | [optional]
|
401
|
-
**ending_before** | **String**| | [optional]
|
104
|
+
**school** | **String**| | [optional]
|
105
|
+
**record_type** | [**Array<String>**](String.md)| | [optional]
|
402
106
|
|
403
107
|
### Return type
|
404
108
|
|
data/docs/Section.md
CHANGED
@@ -3,9 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**course_name** | **String** | | [optional]
|
8
|
-
**course_number** | **String** | | [optional]
|
6
|
+
**course** | **String** | | [optional]
|
9
7
|
**created** | **String** | | [optional]
|
10
8
|
**district** | **String** | | [optional]
|
11
9
|
**grade** | **String** | | [optional]
|
@@ -20,6 +18,6 @@ Name | Type | Description | Notes
|
|
20
18
|
**subject** | **String** | | [optional]
|
21
19
|
**teacher** | **String** | | [optional]
|
22
20
|
**teachers** | **Array<String>** | | [optional]
|
23
|
-
**
|
21
|
+
**term_id** | **String** | | [optional]
|
24
22
|
|
25
23
|
|
data/docs/Term.md
CHANGED
data/docs/TermObject.md
ADDED