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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (188) 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/docs/AdminName.md +0 -1
  8. data/docs/BadRequest.md +0 -1
  9. data/docs/Contact.md +1 -2
  10. data/docs/ContactObject.md +0 -1
  11. data/docs/ContactResponse.md +0 -1
  12. data/docs/ContactsCreated.md +2 -3
  13. data/docs/ContactsDeleted.md +2 -3
  14. data/docs/ContactsResponse.md +0 -1
  15. data/docs/ContactsUpdated.md +2 -3
  16. data/docs/Course.md +1 -2
  17. data/docs/CourseObject.md +0 -1
  18. data/docs/CourseResponse.md +0 -1
  19. data/docs/CoursesCreated.md +2 -3
  20. data/docs/CoursesDeleted.md +2 -3
  21. data/docs/CoursesResponse.md +0 -1
  22. data/docs/CoursesUpdated.md +2 -3
  23. data/docs/Credentials.md +0 -1
  24. data/docs/DataApi.md +2784 -0
  25. data/docs/District.md +9 -10
  26. data/docs/DistrictAdmin.md +2 -3
  27. data/docs/DistrictAdminObject.md +0 -1
  28. data/docs/DistrictAdminResponse.md +0 -1
  29. data/docs/DistrictAdminsResponse.md +0 -1
  30. data/docs/DistrictObject.md +0 -1
  31. data/docs/DistrictResponse.md +0 -1
  32. data/docs/DistrictadminsCreated.md +2 -3
  33. data/docs/DistrictadminsDeleted.md +2 -3
  34. data/docs/DistrictadminsUpdated.md +2 -3
  35. data/docs/DistrictsCreated.md +2 -3
  36. data/docs/DistrictsDeleted.md +2 -3
  37. data/docs/DistrictsResponse.md +0 -1
  38. data/docs/DistrictsUpdated.md +2 -3
  39. data/docs/Event.md +2 -3
  40. data/docs/EventResponse.md +0 -1
  41. data/docs/EventsApi.md +1 -4
  42. data/docs/EventsResponse.md +0 -1
  43. data/docs/InternalError.md +0 -1
  44. data/docs/Link.md +0 -1
  45. data/docs/Location.md +2 -3
  46. data/docs/Name.md +1 -2
  47. data/docs/NotFound.md +0 -1
  48. data/docs/Principal.md +1 -2
  49. data/docs/School.md +3 -4
  50. data/docs/SchoolAdmin.md +3 -4
  51. data/docs/SchoolAdminObject.md +0 -1
  52. data/docs/SchoolAdminResponse.md +0 -1
  53. data/docs/SchoolAdminsResponse.md +0 -1
  54. data/docs/SchoolEnrollment.md +1 -2
  55. data/docs/SchoolObject.md +0 -1
  56. data/docs/SchoolResponse.md +0 -1
  57. data/docs/SchooladminsCreated.md +2 -3
  58. data/docs/SchooladminsDeleted.md +2 -3
  59. data/docs/SchooladminsUpdated.md +2 -3
  60. data/docs/SchoolsCreated.md +2 -3
  61. data/docs/SchoolsDeleted.md +2 -3
  62. data/docs/SchoolsResponse.md +0 -1
  63. data/docs/SchoolsUpdated.md +2 -3
  64. data/docs/Section.md +2 -3
  65. data/docs/SectionObject.md +0 -1
  66. data/docs/SectionResponse.md +0 -1
  67. data/docs/SectionsCreated.md +2 -3
  68. data/docs/SectionsDeleted.md +2 -3
  69. data/docs/SectionsResponse.md +0 -1
  70. data/docs/SectionsUpdated.md +2 -3
  71. data/docs/Student.md +3 -4
  72. data/docs/StudentObject.md +0 -1
  73. data/docs/StudentResponse.md +0 -1
  74. data/docs/StudentsCreated.md +2 -3
  75. data/docs/StudentsDeleted.md +2 -3
  76. data/docs/StudentsResponse.md +0 -1
  77. data/docs/StudentsUpdated.md +2 -3
  78. data/docs/Teacher.md +2 -3
  79. data/docs/TeacherObject.md +0 -1
  80. data/docs/TeacherResponse.md +0 -1
  81. data/docs/TeachersCreated.md +2 -3
  82. data/docs/TeachersDeleted.md +2 -3
  83. data/docs/TeachersResponse.md +0 -1
  84. data/docs/TeachersUpdated.md +2 -3
  85. data/docs/Term.md +2 -3
  86. data/docs/TermObject.md +0 -1
  87. data/docs/TermResponse.md +0 -1
  88. data/docs/TermsCreated.md +2 -3
  89. data/docs/TermsDeleted.md +2 -3
  90. data/docs/TermsResponse.md +0 -1
  91. data/docs/TermsUpdated.md +2 -3
  92. data/git_push.sh +55 -0
  93. data/lib/clever-ruby/api/data_api.rb +2999 -0
  94. data/lib/clever-ruby/api/events_api.rb +25 -20
  95. data/lib/clever-ruby/api_error.rb +23 -4
  96. data/lib/clever-ruby/configuration.rb +5 -9
  97. data/lib/clever-ruby/models/admin_name.rb +46 -22
  98. data/lib/clever-ruby/models/bad_request.rb +42 -20
  99. data/lib/clever-ruby/models/contact.rb +83 -55
  100. data/lib/clever-ruby/models/contact_object.rb +42 -20
  101. data/lib/clever-ruby/models/contact_response.rb +42 -20
  102. data/lib/clever-ruby/models/contacts_response.rb +44 -22
  103. data/lib/clever-ruby/models/course.rb +60 -36
  104. data/lib/clever-ruby/models/course_object.rb +42 -20
  105. data/lib/clever-ruby/models/course_response.rb +42 -20
  106. data/lib/clever-ruby/models/courses_response.rb +44 -22
  107. data/lib/clever-ruby/models/credentials.rb +42 -20
  108. data/lib/clever-ruby/models/district.rb +122 -94
  109. data/lib/clever-ruby/models/district_admin.rb +67 -44
  110. data/lib/clever-ruby/models/district_admin_object.rb +42 -20
  111. data/lib/clever-ruby/models/district_admin_response.rb +42 -20
  112. data/lib/clever-ruby/models/district_admins_response.rb +44 -22
  113. data/lib/clever-ruby/models/district_object.rb +42 -20
  114. data/lib/clever-ruby/models/district_response.rb +42 -20
  115. data/lib/clever-ruby/models/districts_response.rb +44 -22
  116. data/lib/clever-ruby/models/event.rb +60 -33
  117. data/lib/clever-ruby/models/event_response.rb +42 -20
  118. data/lib/clever-ruby/models/events_response.rb +44 -22
  119. data/lib/clever-ruby/models/internal_error.rb +42 -20
  120. data/lib/clever-ruby/models/link.rb +47 -25
  121. data/lib/clever-ruby/models/location.rb +73 -45
  122. data/lib/clever-ruby/models/name.rb +58 -33
  123. data/lib/clever-ruby/models/not_found.rb +42 -20
  124. data/lib/clever-ruby/models/principal.rb +55 -31
  125. data/lib/clever-ruby/models/school.rb +108 -80
  126. data/lib/clever-ruby/models/school_admin.rb +85 -61
  127. data/lib/clever-ruby/models/school_admin_object.rb +42 -20
  128. data/lib/clever-ruby/models/school_admin_response.rb +42 -20
  129. data/lib/clever-ruby/models/school_admins_response.rb +44 -22
  130. data/lib/clever-ruby/models/school_enrollment.rb +56 -34
  131. data/lib/clever-ruby/models/school_object.rb +42 -20
  132. data/lib/clever-ruby/models/school_response.rb +42 -20
  133. data/lib/clever-ruby/models/schools_response.rb +44 -22
  134. data/lib/clever-ruby/models/section.rb +104 -75
  135. data/lib/clever-ruby/models/section_object.rb +42 -20
  136. data/lib/clever-ruby/models/section_response.rb +42 -20
  137. data/lib/clever-ruby/models/sections_response.rb +44 -22
  138. data/lib/clever-ruby/models/student.rb +147 -126
  139. data/lib/clever-ruby/models/student_object.rb +42 -20
  140. data/lib/clever-ruby/models/student_response.rb +42 -20
  141. data/lib/clever-ruby/models/students_response.rb +44 -22
  142. data/lib/clever-ruby/models/teacher.rb +89 -63
  143. data/lib/clever-ruby/models/teacher_object.rb +42 -20
  144. data/lib/clever-ruby/models/teacher_response.rb +42 -20
  145. data/lib/clever-ruby/models/teachers_response.rb +44 -22
  146. data/lib/clever-ruby/models/term.rb +69 -44
  147. data/lib/clever-ruby/models/term_object.rb +42 -20
  148. data/lib/clever-ruby/models/term_response.rb +42 -20
  149. data/lib/clever-ruby/models/terms_response.rb +44 -22
  150. data/lib/clever-ruby/version.rb +4 -5
  151. data/lib/clever-ruby.rb +4 -14
  152. data/override/README-extension.md +1 -1
  153. data/override/override.sh +3 -0
  154. data/spec/api/data_api_spec.rb +671 -0
  155. data/spec/api/events_api_spec.rb +4 -3
  156. data/spec/api_client_spec.rb +21 -3
  157. data/spec/spec_helper.rb +4 -3
  158. metadata +25 -179
  159. data/docs/ContactsApi.md +0 -231
  160. data/docs/CoursesApi.md +0 -231
  161. data/docs/DistrictAdminsApi.md +0 -171
  162. data/docs/DistrictsApi.md +0 -113
  163. data/docs/SchoolAdminsApi.md +0 -231
  164. data/docs/SchoolsApi.md +0 -351
  165. data/docs/SectionsApi.md +0 -499
  166. data/docs/StudentsApi.md +0 -463
  167. data/docs/TeachersApi.md +0 -403
  168. data/docs/TermsApi.md +0 -231
  169. data/lib/clever-ruby/api/contacts_api.rb +0 -241
  170. data/lib/clever-ruby/api/courses_api.rb +0 -241
  171. data/lib/clever-ruby/api/district_admins_api.rb +0 -182
  172. data/lib/clever-ruby/api/districts_api.rb +0 -123
  173. data/lib/clever-ruby/api/school_admins_api.rb +0 -241
  174. data/lib/clever-ruby/api/schools_api.rb +0 -359
  175. data/lib/clever-ruby/api/sections_api.rb +0 -500
  176. data/lib/clever-ruby/api/students_api.rb +0 -468
  177. data/lib/clever-ruby/api/teachers_api.rb +0 -409
  178. data/lib/clever-ruby/api/terms_api.rb +0 -241
  179. data/spec/api/contacts_api_spec.rb +0 -84
  180. data/spec/api/courses_api_spec.rb +0 -84
  181. data/spec/api/district_admins_api_spec.rb +0 -70
  182. data/spec/api/districts_api_spec.rb +0 -56
  183. data/spec/api/school_admins_api_spec.rb +0 -84
  184. data/spec/api/schools_api_spec.rb +0 -112
  185. data/spec/api/sections_api_spec.rb +0 -142
  186. data/spec/api/students_api_spec.rb +0 -137
  187. data/spec/api/teachers_api_spec.rb +0 -123
  188. data/spec/api/terms_api_spec.rb +0 -84
data/docs/DataApi.md ADDED
@@ -0,0 +1,2784 @@
1
+ # Clever::DataApi
2
+
3
+ All URIs are relative to *https://api.clever.com/v2.1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} |
8
+ [**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts |
9
+ [**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
10
+ [**get_course**](DataApi.md#get_course) | **GET** /courses/{id} |
11
+ [**get_course_for_section**](DataApi.md#get_course_for_section) | **GET** /sections/{id}/course |
12
+ [**get_courses**](DataApi.md#get_courses) | **GET** /courses |
13
+ [**get_district**](DataApi.md#get_district) | **GET** /districts/{id} |
14
+ [**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
15
+ [**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins |
16
+ [**get_district_for_contact**](DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
17
+ [**get_district_for_course**](DataApi.md#get_district_for_course) | **GET** /courses/{id}/district |
18
+ [**get_district_for_district_admin**](DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
19
+ [**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
20
+ [**get_district_for_school_admin**](DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
21
+ [**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
22
+ [**get_district_for_student**](DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
23
+ [**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
24
+ [**get_district_for_term**](DataApi.md#get_district_for_term) | **GET** /terms/{id}/district |
25
+ [**get_districts**](DataApi.md#get_districts) | **GET** /districts |
26
+ [**get_school**](DataApi.md#get_school) | **GET** /schools/{id} |
27
+ [**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
28
+ [**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins |
29
+ [**get_school_for_section**](DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
30
+ [**get_school_for_student**](DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
31
+ [**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
32
+ [**get_schools**](DataApi.md#get_schools) | **GET** /schools |
33
+ [**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
34
+ [**get_schools_for_student**](DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
35
+ [**get_schools_for_teacher**](DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
36
+ [**get_section**](DataApi.md#get_section) | **GET** /sections/{id} |
37
+ [**get_sections**](DataApi.md#get_sections) | **GET** /sections |
38
+ [**get_sections_for_course**](DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
39
+ [**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
40
+ [**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
41
+ [**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
42
+ [**get_sections_for_term**](DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
43
+ [**get_student**](DataApi.md#get_student) | **GET** /students/{id} |
44
+ [**get_students**](DataApi.md#get_students) | **GET** /students |
45
+ [**get_students_for_contact**](DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
46
+ [**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
47
+ [**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
48
+ [**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
49
+ [**get_teacher**](DataApi.md#get_teacher) | **GET** /teachers/{id} |
50
+ [**get_teacher_for_section**](DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
51
+ [**get_teachers**](DataApi.md#get_teachers) | **GET** /teachers |
52
+ [**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
53
+ [**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
54
+ [**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
55
+ [**get_term**](DataApi.md#get_term) | **GET** /terms/{id} |
56
+ [**get_term_for_section**](DataApi.md#get_term_for_section) | **GET** /sections/{id}/term |
57
+ [**get_terms**](DataApi.md#get_terms) | **GET** /terms |
58
+
59
+ # **get_contact**
60
+ > ContactResponse get_contact(id)
61
+
62
+
63
+
64
+ Returns a specific student contact
65
+
66
+ ### Example
67
+ ```ruby
68
+ # load the gem
69
+ require 'clever-ruby'
70
+ # setup authorization
71
+ Clever.configure do |config|
72
+ # Configure OAuth2 access token for authorization: oauth
73
+ config.access_token = 'YOUR ACCESS TOKEN'
74
+ end
75
+
76
+ api_instance = Clever::DataApi.new
77
+ id = 'id_example' # String |
78
+
79
+
80
+ begin
81
+ result = api_instance.get_contact(id)
82
+ p result
83
+ rescue Clever::ApiError => e
84
+ puts "Exception when calling DataApi->get_contact: #{e}"
85
+ end
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ Name | Type | Description | Notes
91
+ ------------- | ------------- | ------------- | -------------
92
+ **id** | **String**| |
93
+
94
+ ### Return type
95
+
96
+ [**ContactResponse**](ContactResponse.md)
97
+
98
+ ### Authorization
99
+
100
+ [oauth](../README.md#oauth)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+
109
+ # **get_contacts**
110
+ > ContactsResponse get_contacts(opts)
111
+
112
+
113
+
114
+ Returns a list of student contacts
115
+
116
+ ### Example
117
+ ```ruby
118
+ # load the gem
119
+ require 'clever-ruby'
120
+ # setup authorization
121
+ Clever.configure do |config|
122
+ # Configure OAuth2 access token for authorization: oauth
123
+ config.access_token = 'YOUR ACCESS TOKEN'
124
+ end
125
+
126
+ api_instance = Clever::DataApi.new
127
+ opts = {
128
+ limit: 56, # Integer |
129
+ starting_after: 'starting_after_example', # String |
130
+ ending_before: 'ending_before_example', # String |
131
+ count: 'count_example' # String |
132
+ }
133
+
134
+ begin
135
+ result = api_instance.get_contacts(opts)
136
+ p result
137
+ rescue Clever::ApiError => e
138
+ puts "Exception when calling DataApi->get_contacts: #{e}"
139
+ end
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ Name | Type | Description | Notes
145
+ ------------- | ------------- | ------------- | -------------
146
+ **limit** | **Integer**| | [optional]
147
+ **starting_after** | **String**| | [optional]
148
+ **ending_before** | **String**| | [optional]
149
+ **count** | **String**| | [optional]
150
+
151
+ ### Return type
152
+
153
+ [**ContactsResponse**](ContactsResponse.md)
154
+
155
+ ### Authorization
156
+
157
+ [oauth](../README.md#oauth)
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: Not defined
162
+ - **Accept**: application/json
163
+
164
+
165
+
166
+ # **get_contacts_for_student**
167
+ > ContactsResponse get_contacts_for_student(id, opts)
168
+
169
+
170
+
171
+ Returns the contacts for a student
172
+
173
+ ### Example
174
+ ```ruby
175
+ # load the gem
176
+ require 'clever-ruby'
177
+ # setup authorization
178
+ Clever.configure do |config|
179
+ # Configure OAuth2 access token for authorization: oauth
180
+ config.access_token = 'YOUR ACCESS TOKEN'
181
+ end
182
+
183
+ api_instance = Clever::DataApi.new
184
+ id = 'id_example' # String |
185
+ opts = {
186
+ limit: 56, # Integer |
187
+ starting_after: 'starting_after_example', # String |
188
+ ending_before: 'ending_before_example' # String |
189
+ }
190
+
191
+ begin
192
+ result = api_instance.get_contacts_for_student(id, opts)
193
+ p result
194
+ rescue Clever::ApiError => e
195
+ puts "Exception when calling DataApi->get_contacts_for_student: #{e}"
196
+ end
197
+ ```
198
+
199
+ ### Parameters
200
+
201
+ Name | Type | Description | Notes
202
+ ------------- | ------------- | ------------- | -------------
203
+ **id** | **String**| |
204
+ **limit** | **Integer**| | [optional]
205
+ **starting_after** | **String**| | [optional]
206
+ **ending_before** | **String**| | [optional]
207
+
208
+ ### Return type
209
+
210
+ [**ContactsResponse**](ContactsResponse.md)
211
+
212
+ ### Authorization
213
+
214
+ [oauth](../README.md#oauth)
215
+
216
+ ### HTTP request headers
217
+
218
+ - **Content-Type**: Not defined
219
+ - **Accept**: application/json
220
+
221
+
222
+
223
+ # **get_course**
224
+ > CourseResponse get_course(id)
225
+
226
+
227
+
228
+ Returns a specific course
229
+
230
+ ### Example
231
+ ```ruby
232
+ # load the gem
233
+ require 'clever-ruby'
234
+ # setup authorization
235
+ Clever.configure do |config|
236
+ # Configure OAuth2 access token for authorization: oauth
237
+ config.access_token = 'YOUR ACCESS TOKEN'
238
+ end
239
+
240
+ api_instance = Clever::DataApi.new
241
+ id = 'id_example' # String |
242
+
243
+
244
+ begin
245
+ result = api_instance.get_course(id)
246
+ p result
247
+ rescue Clever::ApiError => e
248
+ puts "Exception when calling DataApi->get_course: #{e}"
249
+ end
250
+ ```
251
+
252
+ ### Parameters
253
+
254
+ Name | Type | Description | Notes
255
+ ------------- | ------------- | ------------- | -------------
256
+ **id** | **String**| |
257
+
258
+ ### Return type
259
+
260
+ [**CourseResponse**](CourseResponse.md)
261
+
262
+ ### Authorization
263
+
264
+ [oauth](../README.md#oauth)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: Not defined
269
+ - **Accept**: application/json
270
+
271
+
272
+
273
+ # **get_course_for_section**
274
+ > CourseResponse get_course_for_section(id)
275
+
276
+
277
+
278
+ Returns the course for a section
279
+
280
+ ### Example
281
+ ```ruby
282
+ # load the gem
283
+ require 'clever-ruby'
284
+ # setup authorization
285
+ Clever.configure do |config|
286
+ # Configure OAuth2 access token for authorization: oauth
287
+ config.access_token = 'YOUR ACCESS TOKEN'
288
+ end
289
+
290
+ api_instance = Clever::DataApi.new
291
+ id = 'id_example' # String |
292
+
293
+
294
+ begin
295
+ result = api_instance.get_course_for_section(id)
296
+ p result
297
+ rescue Clever::ApiError => e
298
+ puts "Exception when calling DataApi->get_course_for_section: #{e}"
299
+ end
300
+ ```
301
+
302
+ ### Parameters
303
+
304
+ Name | Type | Description | Notes
305
+ ------------- | ------------- | ------------- | -------------
306
+ **id** | **String**| |
307
+
308
+ ### Return type
309
+
310
+ [**CourseResponse**](CourseResponse.md)
311
+
312
+ ### Authorization
313
+
314
+ [oauth](../README.md#oauth)
315
+
316
+ ### HTTP request headers
317
+
318
+ - **Content-Type**: Not defined
319
+ - **Accept**: application/json
320
+
321
+
322
+
323
+ # **get_courses**
324
+ > CoursesResponse get_courses(opts)
325
+
326
+
327
+
328
+ Returns a list of courses
329
+
330
+ ### Example
331
+ ```ruby
332
+ # load the gem
333
+ require 'clever-ruby'
334
+ # setup authorization
335
+ Clever.configure do |config|
336
+ # Configure OAuth2 access token for authorization: oauth
337
+ config.access_token = 'YOUR ACCESS TOKEN'
338
+ end
339
+
340
+ api_instance = Clever::DataApi.new
341
+ opts = {
342
+ limit: 56, # Integer |
343
+ starting_after: 'starting_after_example', # String |
344
+ ending_before: 'ending_before_example', # String |
345
+ count: 'count_example' # String |
346
+ }
347
+
348
+ begin
349
+ result = api_instance.get_courses(opts)
350
+ p result
351
+ rescue Clever::ApiError => e
352
+ puts "Exception when calling DataApi->get_courses: #{e}"
353
+ end
354
+ ```
355
+
356
+ ### Parameters
357
+
358
+ Name | Type | Description | Notes
359
+ ------------- | ------------- | ------------- | -------------
360
+ **limit** | **Integer**| | [optional]
361
+ **starting_after** | **String**| | [optional]
362
+ **ending_before** | **String**| | [optional]
363
+ **count** | **String**| | [optional]
364
+
365
+ ### Return type
366
+
367
+ [**CoursesResponse**](CoursesResponse.md)
368
+
369
+ ### Authorization
370
+
371
+ [oauth](../README.md#oauth)
372
+
373
+ ### HTTP request headers
374
+
375
+ - **Content-Type**: Not defined
376
+ - **Accept**: application/json
377
+
378
+
379
+
380
+ # **get_district**
381
+ > DistrictResponse get_district(id)
382
+
383
+
384
+
385
+ Returns a specific district
386
+
387
+ ### Example
388
+ ```ruby
389
+ # load the gem
390
+ require 'clever-ruby'
391
+ # setup authorization
392
+ Clever.configure do |config|
393
+ # Configure OAuth2 access token for authorization: oauth
394
+ config.access_token = 'YOUR ACCESS TOKEN'
395
+ end
396
+
397
+ api_instance = Clever::DataApi.new
398
+ id = 'id_example' # String |
399
+
400
+
401
+ begin
402
+ result = api_instance.get_district(id)
403
+ p result
404
+ rescue Clever::ApiError => e
405
+ puts "Exception when calling DataApi->get_district: #{e}"
406
+ end
407
+ ```
408
+
409
+ ### Parameters
410
+
411
+ Name | Type | Description | Notes
412
+ ------------- | ------------- | ------------- | -------------
413
+ **id** | **String**| |
414
+
415
+ ### Return type
416
+
417
+ [**DistrictResponse**](DistrictResponse.md)
418
+
419
+ ### Authorization
420
+
421
+ [oauth](../README.md#oauth)
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: Not defined
426
+ - **Accept**: application/json
427
+
428
+
429
+
430
+ # **get_district_admin**
431
+ > DistrictAdminResponse get_district_admin(id)
432
+
433
+
434
+
435
+ Returns a specific district admin
436
+
437
+ ### Example
438
+ ```ruby
439
+ # load the gem
440
+ require 'clever-ruby'
441
+ # setup authorization
442
+ Clever.configure do |config|
443
+ # Configure OAuth2 access token for authorization: oauth
444
+ config.access_token = 'YOUR ACCESS TOKEN'
445
+ end
446
+
447
+ api_instance = Clever::DataApi.new
448
+ id = 'id_example' # String |
449
+
450
+
451
+ begin
452
+ result = api_instance.get_district_admin(id)
453
+ p result
454
+ rescue Clever::ApiError => e
455
+ puts "Exception when calling DataApi->get_district_admin: #{e}"
456
+ end
457
+ ```
458
+
459
+ ### Parameters
460
+
461
+ Name | Type | Description | Notes
462
+ ------------- | ------------- | ------------- | -------------
463
+ **id** | **String**| |
464
+
465
+ ### Return type
466
+
467
+ [**DistrictAdminResponse**](DistrictAdminResponse.md)
468
+
469
+ ### Authorization
470
+
471
+ [oauth](../README.md#oauth)
472
+
473
+ ### HTTP request headers
474
+
475
+ - **Content-Type**: Not defined
476
+ - **Accept**: application/json
477
+
478
+
479
+
480
+ # **get_district_admins**
481
+ > DistrictAdminsResponse get_district_admins(opts)
482
+
483
+
484
+
485
+ Returns a list of district admins
486
+
487
+ ### Example
488
+ ```ruby
489
+ # load the gem
490
+ require 'clever-ruby'
491
+ # setup authorization
492
+ Clever.configure do |config|
493
+ # Configure OAuth2 access token for authorization: oauth
494
+ config.access_token = 'YOUR ACCESS TOKEN'
495
+ end
496
+
497
+ api_instance = Clever::DataApi.new
498
+ opts = {
499
+ limit: 56, # Integer |
500
+ starting_after: 'starting_after_example', # String |
501
+ ending_before: 'ending_before_example', # String |
502
+ count: 'count_example' # String |
503
+ }
504
+
505
+ begin
506
+ result = api_instance.get_district_admins(opts)
507
+ p result
508
+ rescue Clever::ApiError => e
509
+ puts "Exception when calling DataApi->get_district_admins: #{e}"
510
+ end
511
+ ```
512
+
513
+ ### Parameters
514
+
515
+ Name | Type | Description | Notes
516
+ ------------- | ------------- | ------------- | -------------
517
+ **limit** | **Integer**| | [optional]
518
+ **starting_after** | **String**| | [optional]
519
+ **ending_before** | **String**| | [optional]
520
+ **count** | **String**| | [optional]
521
+
522
+ ### Return type
523
+
524
+ [**DistrictAdminsResponse**](DistrictAdminsResponse.md)
525
+
526
+ ### Authorization
527
+
528
+ [oauth](../README.md#oauth)
529
+
530
+ ### HTTP request headers
531
+
532
+ - **Content-Type**: Not defined
533
+ - **Accept**: application/json
534
+
535
+
536
+
537
+ # **get_district_for_contact**
538
+ > DistrictResponse get_district_for_contact(id)
539
+
540
+
541
+
542
+ Returns the district for a student contact
543
+
544
+ ### Example
545
+ ```ruby
546
+ # load the gem
547
+ require 'clever-ruby'
548
+ # setup authorization
549
+ Clever.configure do |config|
550
+ # Configure OAuth2 access token for authorization: oauth
551
+ config.access_token = 'YOUR ACCESS TOKEN'
552
+ end
553
+
554
+ api_instance = Clever::DataApi.new
555
+ id = 'id_example' # String |
556
+
557
+
558
+ begin
559
+ result = api_instance.get_district_for_contact(id)
560
+ p result
561
+ rescue Clever::ApiError => e
562
+ puts "Exception when calling DataApi->get_district_for_contact: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ Name | Type | Description | Notes
569
+ ------------- | ------------- | ------------- | -------------
570
+ **id** | **String**| |
571
+
572
+ ### Return type
573
+
574
+ [**DistrictResponse**](DistrictResponse.md)
575
+
576
+ ### Authorization
577
+
578
+ [oauth](../README.md#oauth)
579
+
580
+ ### HTTP request headers
581
+
582
+ - **Content-Type**: Not defined
583
+ - **Accept**: application/json
584
+
585
+
586
+
587
+ # **get_district_for_course**
588
+ > DistrictResponse get_district_for_course(id)
589
+
590
+
591
+
592
+ Returns the district for a course
593
+
594
+ ### Example
595
+ ```ruby
596
+ # load the gem
597
+ require 'clever-ruby'
598
+ # setup authorization
599
+ Clever.configure do |config|
600
+ # Configure OAuth2 access token for authorization: oauth
601
+ config.access_token = 'YOUR ACCESS TOKEN'
602
+ end
603
+
604
+ api_instance = Clever::DataApi.new
605
+ id = 'id_example' # String |
606
+
607
+
608
+ begin
609
+ result = api_instance.get_district_for_course(id)
610
+ p result
611
+ rescue Clever::ApiError => e
612
+ puts "Exception when calling DataApi->get_district_for_course: #{e}"
613
+ end
614
+ ```
615
+
616
+ ### Parameters
617
+
618
+ Name | Type | Description | Notes
619
+ ------------- | ------------- | ------------- | -------------
620
+ **id** | **String**| |
621
+
622
+ ### Return type
623
+
624
+ [**DistrictResponse**](DistrictResponse.md)
625
+
626
+ ### Authorization
627
+
628
+ [oauth](../README.md#oauth)
629
+
630
+ ### HTTP request headers
631
+
632
+ - **Content-Type**: Not defined
633
+ - **Accept**: application/json
634
+
635
+
636
+
637
+ # **get_district_for_district_admin**
638
+ > DistrictResponse get_district_for_district_admin(id)
639
+
640
+
641
+
642
+ Returns the district for a district admin
643
+
644
+ ### Example
645
+ ```ruby
646
+ # load the gem
647
+ require 'clever-ruby'
648
+ # setup authorization
649
+ Clever.configure do |config|
650
+ # Configure OAuth2 access token for authorization: oauth
651
+ config.access_token = 'YOUR ACCESS TOKEN'
652
+ end
653
+
654
+ api_instance = Clever::DataApi.new
655
+ id = 'id_example' # String |
656
+
657
+
658
+ begin
659
+ result = api_instance.get_district_for_district_admin(id)
660
+ p result
661
+ rescue Clever::ApiError => e
662
+ puts "Exception when calling DataApi->get_district_for_district_admin: #{e}"
663
+ end
664
+ ```
665
+
666
+ ### Parameters
667
+
668
+ Name | Type | Description | Notes
669
+ ------------- | ------------- | ------------- | -------------
670
+ **id** | **String**| |
671
+
672
+ ### Return type
673
+
674
+ [**DistrictResponse**](DistrictResponse.md)
675
+
676
+ ### Authorization
677
+
678
+ [oauth](../README.md#oauth)
679
+
680
+ ### HTTP request headers
681
+
682
+ - **Content-Type**: Not defined
683
+ - **Accept**: application/json
684
+
685
+
686
+
687
+ # **get_district_for_school**
688
+ > DistrictResponse get_district_for_school(id)
689
+
690
+
691
+
692
+ Returns the district for a school
693
+
694
+ ### Example
695
+ ```ruby
696
+ # load the gem
697
+ require 'clever-ruby'
698
+ # setup authorization
699
+ Clever.configure do |config|
700
+ # Configure OAuth2 access token for authorization: oauth
701
+ config.access_token = 'YOUR ACCESS TOKEN'
702
+ end
703
+
704
+ api_instance = Clever::DataApi.new
705
+ id = 'id_example' # String |
706
+
707
+
708
+ begin
709
+ result = api_instance.get_district_for_school(id)
710
+ p result
711
+ rescue Clever::ApiError => e
712
+ puts "Exception when calling DataApi->get_district_for_school: #{e}"
713
+ end
714
+ ```
715
+
716
+ ### Parameters
717
+
718
+ Name | Type | Description | Notes
719
+ ------------- | ------------- | ------------- | -------------
720
+ **id** | **String**| |
721
+
722
+ ### Return type
723
+
724
+ [**DistrictResponse**](DistrictResponse.md)
725
+
726
+ ### Authorization
727
+
728
+ [oauth](../README.md#oauth)
729
+
730
+ ### HTTP request headers
731
+
732
+ - **Content-Type**: Not defined
733
+ - **Accept**: application/json
734
+
735
+
736
+
737
+ # **get_district_for_school_admin**
738
+ > DistrictResponse get_district_for_school_admin(id)
739
+
740
+
741
+
742
+ Returns the district for a school admin
743
+
744
+ ### Example
745
+ ```ruby
746
+ # load the gem
747
+ require 'clever-ruby'
748
+ # setup authorization
749
+ Clever.configure do |config|
750
+ # Configure OAuth2 access token for authorization: oauth
751
+ config.access_token = 'YOUR ACCESS TOKEN'
752
+ end
753
+
754
+ api_instance = Clever::DataApi.new
755
+ id = 'id_example' # String |
756
+
757
+
758
+ begin
759
+ result = api_instance.get_district_for_school_admin(id)
760
+ p result
761
+ rescue Clever::ApiError => e
762
+ puts "Exception when calling DataApi->get_district_for_school_admin: #{e}"
763
+ end
764
+ ```
765
+
766
+ ### Parameters
767
+
768
+ Name | Type | Description | Notes
769
+ ------------- | ------------- | ------------- | -------------
770
+ **id** | **String**| |
771
+
772
+ ### Return type
773
+
774
+ [**DistrictResponse**](DistrictResponse.md)
775
+
776
+ ### Authorization
777
+
778
+ [oauth](../README.md#oauth)
779
+
780
+ ### HTTP request headers
781
+
782
+ - **Content-Type**: Not defined
783
+ - **Accept**: application/json
784
+
785
+
786
+
787
+ # **get_district_for_section**
788
+ > DistrictResponse get_district_for_section(id)
789
+
790
+
791
+
792
+ Returns the district for a section
793
+
794
+ ### Example
795
+ ```ruby
796
+ # load the gem
797
+ require 'clever-ruby'
798
+ # setup authorization
799
+ Clever.configure do |config|
800
+ # Configure OAuth2 access token for authorization: oauth
801
+ config.access_token = 'YOUR ACCESS TOKEN'
802
+ end
803
+
804
+ api_instance = Clever::DataApi.new
805
+ id = 'id_example' # String |
806
+
807
+
808
+ begin
809
+ result = api_instance.get_district_for_section(id)
810
+ p result
811
+ rescue Clever::ApiError => e
812
+ puts "Exception when calling DataApi->get_district_for_section: #{e}"
813
+ end
814
+ ```
815
+
816
+ ### Parameters
817
+
818
+ Name | Type | Description | Notes
819
+ ------------- | ------------- | ------------- | -------------
820
+ **id** | **String**| |
821
+
822
+ ### Return type
823
+
824
+ [**DistrictResponse**](DistrictResponse.md)
825
+
826
+ ### Authorization
827
+
828
+ [oauth](../README.md#oauth)
829
+
830
+ ### HTTP request headers
831
+
832
+ - **Content-Type**: Not defined
833
+ - **Accept**: application/json
834
+
835
+
836
+
837
+ # **get_district_for_student**
838
+ > DistrictResponse get_district_for_student(id)
839
+
840
+
841
+
842
+ Returns the district for a student
843
+
844
+ ### Example
845
+ ```ruby
846
+ # load the gem
847
+ require 'clever-ruby'
848
+ # setup authorization
849
+ Clever.configure do |config|
850
+ # Configure OAuth2 access token for authorization: oauth
851
+ config.access_token = 'YOUR ACCESS TOKEN'
852
+ end
853
+
854
+ api_instance = Clever::DataApi.new
855
+ id = 'id_example' # String |
856
+
857
+
858
+ begin
859
+ result = api_instance.get_district_for_student(id)
860
+ p result
861
+ rescue Clever::ApiError => e
862
+ puts "Exception when calling DataApi->get_district_for_student: #{e}"
863
+ end
864
+ ```
865
+
866
+ ### Parameters
867
+
868
+ Name | Type | Description | Notes
869
+ ------------- | ------------- | ------------- | -------------
870
+ **id** | **String**| |
871
+
872
+ ### Return type
873
+
874
+ [**DistrictResponse**](DistrictResponse.md)
875
+
876
+ ### Authorization
877
+
878
+ [oauth](../README.md#oauth)
879
+
880
+ ### HTTP request headers
881
+
882
+ - **Content-Type**: Not defined
883
+ - **Accept**: application/json
884
+
885
+
886
+
887
+ # **get_district_for_teacher**
888
+ > DistrictResponse get_district_for_teacher(id)
889
+
890
+
891
+
892
+ Returns the district for a teacher
893
+
894
+ ### Example
895
+ ```ruby
896
+ # load the gem
897
+ require 'clever-ruby'
898
+ # setup authorization
899
+ Clever.configure do |config|
900
+ # Configure OAuth2 access token for authorization: oauth
901
+ config.access_token = 'YOUR ACCESS TOKEN'
902
+ end
903
+
904
+ api_instance = Clever::DataApi.new
905
+ id = 'id_example' # String |
906
+
907
+
908
+ begin
909
+ result = api_instance.get_district_for_teacher(id)
910
+ p result
911
+ rescue Clever::ApiError => e
912
+ puts "Exception when calling DataApi->get_district_for_teacher: #{e}"
913
+ end
914
+ ```
915
+
916
+ ### Parameters
917
+
918
+ Name | Type | Description | Notes
919
+ ------------- | ------------- | ------------- | -------------
920
+ **id** | **String**| |
921
+
922
+ ### Return type
923
+
924
+ [**DistrictResponse**](DistrictResponse.md)
925
+
926
+ ### Authorization
927
+
928
+ [oauth](../README.md#oauth)
929
+
930
+ ### HTTP request headers
931
+
932
+ - **Content-Type**: Not defined
933
+ - **Accept**: application/json
934
+
935
+
936
+
937
+ # **get_district_for_term**
938
+ > DistrictResponse get_district_for_term(id)
939
+
940
+
941
+
942
+ Returns the district for a term
943
+
944
+ ### Example
945
+ ```ruby
946
+ # load the gem
947
+ require 'clever-ruby'
948
+ # setup authorization
949
+ Clever.configure do |config|
950
+ # Configure OAuth2 access token for authorization: oauth
951
+ config.access_token = 'YOUR ACCESS TOKEN'
952
+ end
953
+
954
+ api_instance = Clever::DataApi.new
955
+ id = 'id_example' # String |
956
+
957
+
958
+ begin
959
+ result = api_instance.get_district_for_term(id)
960
+ p result
961
+ rescue Clever::ApiError => e
962
+ puts "Exception when calling DataApi->get_district_for_term: #{e}"
963
+ end
964
+ ```
965
+
966
+ ### Parameters
967
+
968
+ Name | Type | Description | Notes
969
+ ------------- | ------------- | ------------- | -------------
970
+ **id** | **String**| |
971
+
972
+ ### Return type
973
+
974
+ [**DistrictResponse**](DistrictResponse.md)
975
+
976
+ ### Authorization
977
+
978
+ [oauth](../README.md#oauth)
979
+
980
+ ### HTTP request headers
981
+
982
+ - **Content-Type**: Not defined
983
+ - **Accept**: application/json
984
+
985
+
986
+
987
+ # **get_districts**
988
+ > DistrictsResponse get_districts(opts)
989
+
990
+
991
+
992
+ Returns a list of districts. In practice this will only return the one district associated with the bearer token
993
+
994
+ ### Example
995
+ ```ruby
996
+ # load the gem
997
+ require 'clever-ruby'
998
+ # setup authorization
999
+ Clever.configure do |config|
1000
+ # Configure OAuth2 access token for authorization: oauth
1001
+ config.access_token = 'YOUR ACCESS TOKEN'
1002
+ end
1003
+
1004
+ api_instance = Clever::DataApi.new
1005
+ opts = {
1006
+ count: 'count_example' # String |
1007
+ }
1008
+
1009
+ begin
1010
+ result = api_instance.get_districts(opts)
1011
+ p result
1012
+ rescue Clever::ApiError => e
1013
+ puts "Exception when calling DataApi->get_districts: #{e}"
1014
+ end
1015
+ ```
1016
+
1017
+ ### Parameters
1018
+
1019
+ Name | Type | Description | Notes
1020
+ ------------- | ------------- | ------------- | -------------
1021
+ **count** | **String**| | [optional]
1022
+
1023
+ ### Return type
1024
+
1025
+ [**DistrictsResponse**](DistrictsResponse.md)
1026
+
1027
+ ### Authorization
1028
+
1029
+ [oauth](../README.md#oauth)
1030
+
1031
+ ### HTTP request headers
1032
+
1033
+ - **Content-Type**: Not defined
1034
+ - **Accept**: application/json
1035
+
1036
+
1037
+
1038
+ # **get_school**
1039
+ > SchoolResponse get_school(id)
1040
+
1041
+
1042
+
1043
+ Returns a specific school
1044
+
1045
+ ### Example
1046
+ ```ruby
1047
+ # load the gem
1048
+ require 'clever-ruby'
1049
+ # setup authorization
1050
+ Clever.configure do |config|
1051
+ # Configure OAuth2 access token for authorization: oauth
1052
+ config.access_token = 'YOUR ACCESS TOKEN'
1053
+ end
1054
+
1055
+ api_instance = Clever::DataApi.new
1056
+ id = 'id_example' # String |
1057
+
1058
+
1059
+ begin
1060
+ result = api_instance.get_school(id)
1061
+ p result
1062
+ rescue Clever::ApiError => e
1063
+ puts "Exception when calling DataApi->get_school: #{e}"
1064
+ end
1065
+ ```
1066
+
1067
+ ### Parameters
1068
+
1069
+ Name | Type | Description | Notes
1070
+ ------------- | ------------- | ------------- | -------------
1071
+ **id** | **String**| |
1072
+
1073
+ ### Return type
1074
+
1075
+ [**SchoolResponse**](SchoolResponse.md)
1076
+
1077
+ ### Authorization
1078
+
1079
+ [oauth](../README.md#oauth)
1080
+
1081
+ ### HTTP request headers
1082
+
1083
+ - **Content-Type**: Not defined
1084
+ - **Accept**: application/json
1085
+
1086
+
1087
+
1088
+ # **get_school_admin**
1089
+ > SchoolAdminResponse get_school_admin(id)
1090
+
1091
+
1092
+
1093
+ Returns a specific school admin
1094
+
1095
+ ### Example
1096
+ ```ruby
1097
+ # load the gem
1098
+ require 'clever-ruby'
1099
+ # setup authorization
1100
+ Clever.configure do |config|
1101
+ # Configure OAuth2 access token for authorization: oauth
1102
+ config.access_token = 'YOUR ACCESS TOKEN'
1103
+ end
1104
+
1105
+ api_instance = Clever::DataApi.new
1106
+ id = 'id_example' # String |
1107
+
1108
+
1109
+ begin
1110
+ result = api_instance.get_school_admin(id)
1111
+ p result
1112
+ rescue Clever::ApiError => e
1113
+ puts "Exception when calling DataApi->get_school_admin: #{e}"
1114
+ end
1115
+ ```
1116
+
1117
+ ### Parameters
1118
+
1119
+ Name | Type | Description | Notes
1120
+ ------------- | ------------- | ------------- | -------------
1121
+ **id** | **String**| |
1122
+
1123
+ ### Return type
1124
+
1125
+ [**SchoolAdminResponse**](SchoolAdminResponse.md)
1126
+
1127
+ ### Authorization
1128
+
1129
+ [oauth](../README.md#oauth)
1130
+
1131
+ ### HTTP request headers
1132
+
1133
+ - **Content-Type**: Not defined
1134
+ - **Accept**: application/json
1135
+
1136
+
1137
+
1138
+ # **get_school_admins**
1139
+ > SchoolAdminsResponse get_school_admins(opts)
1140
+
1141
+
1142
+
1143
+ Returns a list of school admins
1144
+
1145
+ ### Example
1146
+ ```ruby
1147
+ # load the gem
1148
+ require 'clever-ruby'
1149
+ # setup authorization
1150
+ Clever.configure do |config|
1151
+ # Configure OAuth2 access token for authorization: oauth
1152
+ config.access_token = 'YOUR ACCESS TOKEN'
1153
+ end
1154
+
1155
+ api_instance = Clever::DataApi.new
1156
+ opts = {
1157
+ limit: 56, # Integer |
1158
+ starting_after: 'starting_after_example', # String |
1159
+ ending_before: 'ending_before_example', # String |
1160
+ count: 'count_example' # String |
1161
+ }
1162
+
1163
+ begin
1164
+ result = api_instance.get_school_admins(opts)
1165
+ p result
1166
+ rescue Clever::ApiError => e
1167
+ puts "Exception when calling DataApi->get_school_admins: #{e}"
1168
+ end
1169
+ ```
1170
+
1171
+ ### Parameters
1172
+
1173
+ Name | Type | Description | Notes
1174
+ ------------- | ------------- | ------------- | -------------
1175
+ **limit** | **Integer**| | [optional]
1176
+ **starting_after** | **String**| | [optional]
1177
+ **ending_before** | **String**| | [optional]
1178
+ **count** | **String**| | [optional]
1179
+
1180
+ ### Return type
1181
+
1182
+ [**SchoolAdminsResponse**](SchoolAdminsResponse.md)
1183
+
1184
+ ### Authorization
1185
+
1186
+ [oauth](../README.md#oauth)
1187
+
1188
+ ### HTTP request headers
1189
+
1190
+ - **Content-Type**: Not defined
1191
+ - **Accept**: application/json
1192
+
1193
+
1194
+
1195
+ # **get_school_for_section**
1196
+ > SchoolResponse get_school_for_section(id)
1197
+
1198
+
1199
+
1200
+ Returns the school for a section
1201
+
1202
+ ### Example
1203
+ ```ruby
1204
+ # load the gem
1205
+ require 'clever-ruby'
1206
+ # setup authorization
1207
+ Clever.configure do |config|
1208
+ # Configure OAuth2 access token for authorization: oauth
1209
+ config.access_token = 'YOUR ACCESS TOKEN'
1210
+ end
1211
+
1212
+ api_instance = Clever::DataApi.new
1213
+ id = 'id_example' # String |
1214
+
1215
+
1216
+ begin
1217
+ result = api_instance.get_school_for_section(id)
1218
+ p result
1219
+ rescue Clever::ApiError => e
1220
+ puts "Exception when calling DataApi->get_school_for_section: #{e}"
1221
+ end
1222
+ ```
1223
+
1224
+ ### Parameters
1225
+
1226
+ Name | Type | Description | Notes
1227
+ ------------- | ------------- | ------------- | -------------
1228
+ **id** | **String**| |
1229
+
1230
+ ### Return type
1231
+
1232
+ [**SchoolResponse**](SchoolResponse.md)
1233
+
1234
+ ### Authorization
1235
+
1236
+ [oauth](../README.md#oauth)
1237
+
1238
+ ### HTTP request headers
1239
+
1240
+ - **Content-Type**: Not defined
1241
+ - **Accept**: application/json
1242
+
1243
+
1244
+
1245
+ # **get_school_for_student**
1246
+ > SchoolResponse get_school_for_student(id)
1247
+
1248
+
1249
+
1250
+ Returns the primary school for a student
1251
+
1252
+ ### Example
1253
+ ```ruby
1254
+ # load the gem
1255
+ require 'clever-ruby'
1256
+ # setup authorization
1257
+ Clever.configure do |config|
1258
+ # Configure OAuth2 access token for authorization: oauth
1259
+ config.access_token = 'YOUR ACCESS TOKEN'
1260
+ end
1261
+
1262
+ api_instance = Clever::DataApi.new
1263
+ id = 'id_example' # String |
1264
+
1265
+
1266
+ begin
1267
+ result = api_instance.get_school_for_student(id)
1268
+ p result
1269
+ rescue Clever::ApiError => e
1270
+ puts "Exception when calling DataApi->get_school_for_student: #{e}"
1271
+ end
1272
+ ```
1273
+
1274
+ ### Parameters
1275
+
1276
+ Name | Type | Description | Notes
1277
+ ------------- | ------------- | ------------- | -------------
1278
+ **id** | **String**| |
1279
+
1280
+ ### Return type
1281
+
1282
+ [**SchoolResponse**](SchoolResponse.md)
1283
+
1284
+ ### Authorization
1285
+
1286
+ [oauth](../README.md#oauth)
1287
+
1288
+ ### HTTP request headers
1289
+
1290
+ - **Content-Type**: Not defined
1291
+ - **Accept**: application/json
1292
+
1293
+
1294
+
1295
+ # **get_school_for_teacher**
1296
+ > SchoolResponse get_school_for_teacher(id)
1297
+
1298
+
1299
+
1300
+ Retrieves school info for a teacher.
1301
+
1302
+ ### Example
1303
+ ```ruby
1304
+ # load the gem
1305
+ require 'clever-ruby'
1306
+ # setup authorization
1307
+ Clever.configure do |config|
1308
+ # Configure OAuth2 access token for authorization: oauth
1309
+ config.access_token = 'YOUR ACCESS TOKEN'
1310
+ end
1311
+
1312
+ api_instance = Clever::DataApi.new
1313
+ id = 'id_example' # String |
1314
+
1315
+
1316
+ begin
1317
+ result = api_instance.get_school_for_teacher(id)
1318
+ p result
1319
+ rescue Clever::ApiError => e
1320
+ puts "Exception when calling DataApi->get_school_for_teacher: #{e}"
1321
+ end
1322
+ ```
1323
+
1324
+ ### Parameters
1325
+
1326
+ Name | Type | Description | Notes
1327
+ ------------- | ------------- | ------------- | -------------
1328
+ **id** | **String**| |
1329
+
1330
+ ### Return type
1331
+
1332
+ [**SchoolResponse**](SchoolResponse.md)
1333
+
1334
+ ### Authorization
1335
+
1336
+ [oauth](../README.md#oauth)
1337
+
1338
+ ### HTTP request headers
1339
+
1340
+ - **Content-Type**: Not defined
1341
+ - **Accept**: application/json
1342
+
1343
+
1344
+
1345
+ # **get_schools**
1346
+ > SchoolsResponse get_schools(opts)
1347
+
1348
+
1349
+
1350
+ Returns a list of schools
1351
+
1352
+ ### Example
1353
+ ```ruby
1354
+ # load the gem
1355
+ require 'clever-ruby'
1356
+ # setup authorization
1357
+ Clever.configure do |config|
1358
+ # Configure OAuth2 access token for authorization: oauth
1359
+ config.access_token = 'YOUR ACCESS TOKEN'
1360
+ end
1361
+
1362
+ api_instance = Clever::DataApi.new
1363
+ opts = {
1364
+ limit: 56, # Integer |
1365
+ starting_after: 'starting_after_example', # String |
1366
+ ending_before: 'ending_before_example', # String |
1367
+ count: 'count_example' # String |
1368
+ }
1369
+
1370
+ begin
1371
+ result = api_instance.get_schools(opts)
1372
+ p result
1373
+ rescue Clever::ApiError => e
1374
+ puts "Exception when calling DataApi->get_schools: #{e}"
1375
+ end
1376
+ ```
1377
+
1378
+ ### Parameters
1379
+
1380
+ Name | Type | Description | Notes
1381
+ ------------- | ------------- | ------------- | -------------
1382
+ **limit** | **Integer**| | [optional]
1383
+ **starting_after** | **String**| | [optional]
1384
+ **ending_before** | **String**| | [optional]
1385
+ **count** | **String**| | [optional]
1386
+
1387
+ ### Return type
1388
+
1389
+ [**SchoolsResponse**](SchoolsResponse.md)
1390
+
1391
+ ### Authorization
1392
+
1393
+ [oauth](../README.md#oauth)
1394
+
1395
+ ### HTTP request headers
1396
+
1397
+ - **Content-Type**: Not defined
1398
+ - **Accept**: application/json
1399
+
1400
+
1401
+
1402
+ # **get_schools_for_school_admin**
1403
+ > SchoolsResponse get_schools_for_school_admin(id, opts)
1404
+
1405
+
1406
+
1407
+ Returns the schools for a school admin
1408
+
1409
+ ### Example
1410
+ ```ruby
1411
+ # load the gem
1412
+ require 'clever-ruby'
1413
+ # setup authorization
1414
+ Clever.configure do |config|
1415
+ # Configure OAuth2 access token for authorization: oauth
1416
+ config.access_token = 'YOUR ACCESS TOKEN'
1417
+ end
1418
+
1419
+ api_instance = Clever::DataApi.new
1420
+ id = 'id_example' # String |
1421
+ opts = {
1422
+ limit: 56, # Integer |
1423
+ starting_after: 'starting_after_example', # String |
1424
+ ending_before: 'ending_before_example' # String |
1425
+ }
1426
+
1427
+ begin
1428
+ result = api_instance.get_schools_for_school_admin(id, opts)
1429
+ p result
1430
+ rescue Clever::ApiError => e
1431
+ puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}"
1432
+ end
1433
+ ```
1434
+
1435
+ ### Parameters
1436
+
1437
+ Name | Type | Description | Notes
1438
+ ------------- | ------------- | ------------- | -------------
1439
+ **id** | **String**| |
1440
+ **limit** | **Integer**| | [optional]
1441
+ **starting_after** | **String**| | [optional]
1442
+ **ending_before** | **String**| | [optional]
1443
+
1444
+ ### Return type
1445
+
1446
+ [**SchoolsResponse**](SchoolsResponse.md)
1447
+
1448
+ ### Authorization
1449
+
1450
+ [oauth](../README.md#oauth)
1451
+
1452
+ ### HTTP request headers
1453
+
1454
+ - **Content-Type**: Not defined
1455
+ - **Accept**: application/json
1456
+
1457
+
1458
+
1459
+ # **get_schools_for_student**
1460
+ > SchoolsResponse get_schools_for_student(id, opts)
1461
+
1462
+
1463
+
1464
+ Returns the schools for a student
1465
+
1466
+ ### Example
1467
+ ```ruby
1468
+ # load the gem
1469
+ require 'clever-ruby'
1470
+ # setup authorization
1471
+ Clever.configure do |config|
1472
+ # Configure OAuth2 access token for authorization: oauth
1473
+ config.access_token = 'YOUR ACCESS TOKEN'
1474
+ end
1475
+
1476
+ api_instance = Clever::DataApi.new
1477
+ id = 'id_example' # String |
1478
+ opts = {
1479
+ limit: 56, # Integer |
1480
+ starting_after: 'starting_after_example', # String |
1481
+ ending_before: 'ending_before_example' # String |
1482
+ }
1483
+
1484
+ begin
1485
+ result = api_instance.get_schools_for_student(id, opts)
1486
+ p result
1487
+ rescue Clever::ApiError => e
1488
+ puts "Exception when calling DataApi->get_schools_for_student: #{e}"
1489
+ end
1490
+ ```
1491
+
1492
+ ### Parameters
1493
+
1494
+ Name | Type | Description | Notes
1495
+ ------------- | ------------- | ------------- | -------------
1496
+ **id** | **String**| |
1497
+ **limit** | **Integer**| | [optional]
1498
+ **starting_after** | **String**| | [optional]
1499
+ **ending_before** | **String**| | [optional]
1500
+
1501
+ ### Return type
1502
+
1503
+ [**SchoolsResponse**](SchoolsResponse.md)
1504
+
1505
+ ### Authorization
1506
+
1507
+ [oauth](../README.md#oauth)
1508
+
1509
+ ### HTTP request headers
1510
+
1511
+ - **Content-Type**: Not defined
1512
+ - **Accept**: application/json
1513
+
1514
+
1515
+
1516
+ # **get_schools_for_teacher**
1517
+ > SchoolsResponse get_schools_for_teacher(id, opts)
1518
+
1519
+
1520
+
1521
+ Returns the schools for a teacher
1522
+
1523
+ ### Example
1524
+ ```ruby
1525
+ # load the gem
1526
+ require 'clever-ruby'
1527
+ # setup authorization
1528
+ Clever.configure do |config|
1529
+ # Configure OAuth2 access token for authorization: oauth
1530
+ config.access_token = 'YOUR ACCESS TOKEN'
1531
+ end
1532
+
1533
+ api_instance = Clever::DataApi.new
1534
+ id = 'id_example' # String |
1535
+ opts = {
1536
+ limit: 56, # Integer |
1537
+ starting_after: 'starting_after_example', # String |
1538
+ ending_before: 'ending_before_example' # String |
1539
+ }
1540
+
1541
+ begin
1542
+ result = api_instance.get_schools_for_teacher(id, opts)
1543
+ p result
1544
+ rescue Clever::ApiError => e
1545
+ puts "Exception when calling DataApi->get_schools_for_teacher: #{e}"
1546
+ end
1547
+ ```
1548
+
1549
+ ### Parameters
1550
+
1551
+ Name | Type | Description | Notes
1552
+ ------------- | ------------- | ------------- | -------------
1553
+ **id** | **String**| |
1554
+ **limit** | **Integer**| | [optional]
1555
+ **starting_after** | **String**| | [optional]
1556
+ **ending_before** | **String**| | [optional]
1557
+
1558
+ ### Return type
1559
+
1560
+ [**SchoolsResponse**](SchoolsResponse.md)
1561
+
1562
+ ### Authorization
1563
+
1564
+ [oauth](../README.md#oauth)
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: Not defined
1569
+ - **Accept**: application/json
1570
+
1571
+
1572
+
1573
+ # **get_section**
1574
+ > SectionResponse get_section(id)
1575
+
1576
+
1577
+
1578
+ Returns a specific section
1579
+
1580
+ ### Example
1581
+ ```ruby
1582
+ # load the gem
1583
+ require 'clever-ruby'
1584
+ # setup authorization
1585
+ Clever.configure do |config|
1586
+ # Configure OAuth2 access token for authorization: oauth
1587
+ config.access_token = 'YOUR ACCESS TOKEN'
1588
+ end
1589
+
1590
+ api_instance = Clever::DataApi.new
1591
+ id = 'id_example' # String |
1592
+
1593
+
1594
+ begin
1595
+ result = api_instance.get_section(id)
1596
+ p result
1597
+ rescue Clever::ApiError => e
1598
+ puts "Exception when calling DataApi->get_section: #{e}"
1599
+ end
1600
+ ```
1601
+
1602
+ ### Parameters
1603
+
1604
+ Name | Type | Description | Notes
1605
+ ------------- | ------------- | ------------- | -------------
1606
+ **id** | **String**| |
1607
+
1608
+ ### Return type
1609
+
1610
+ [**SectionResponse**](SectionResponse.md)
1611
+
1612
+ ### Authorization
1613
+
1614
+ [oauth](../README.md#oauth)
1615
+
1616
+ ### HTTP request headers
1617
+
1618
+ - **Content-Type**: Not defined
1619
+ - **Accept**: application/json
1620
+
1621
+
1622
+
1623
+ # **get_sections**
1624
+ > SectionsResponse get_sections(opts)
1625
+
1626
+
1627
+
1628
+ Returns a list of sections
1629
+
1630
+ ### Example
1631
+ ```ruby
1632
+ # load the gem
1633
+ require 'clever-ruby'
1634
+ # setup authorization
1635
+ Clever.configure do |config|
1636
+ # Configure OAuth2 access token for authorization: oauth
1637
+ config.access_token = 'YOUR ACCESS TOKEN'
1638
+ end
1639
+
1640
+ api_instance = Clever::DataApi.new
1641
+ opts = {
1642
+ limit: 56, # Integer |
1643
+ starting_after: 'starting_after_example', # String |
1644
+ ending_before: 'ending_before_example', # String |
1645
+ count: 'count_example' # String |
1646
+ }
1647
+
1648
+ begin
1649
+ result = api_instance.get_sections(opts)
1650
+ p result
1651
+ rescue Clever::ApiError => e
1652
+ puts "Exception when calling DataApi->get_sections: #{e}"
1653
+ end
1654
+ ```
1655
+
1656
+ ### Parameters
1657
+
1658
+ Name | Type | Description | Notes
1659
+ ------------- | ------------- | ------------- | -------------
1660
+ **limit** | **Integer**| | [optional]
1661
+ **starting_after** | **String**| | [optional]
1662
+ **ending_before** | **String**| | [optional]
1663
+ **count** | **String**| | [optional]
1664
+
1665
+ ### Return type
1666
+
1667
+ [**SectionsResponse**](SectionsResponse.md)
1668
+
1669
+ ### Authorization
1670
+
1671
+ [oauth](../README.md#oauth)
1672
+
1673
+ ### HTTP request headers
1674
+
1675
+ - **Content-Type**: Not defined
1676
+ - **Accept**: application/json
1677
+
1678
+
1679
+
1680
+ # **get_sections_for_course**
1681
+ > SectionsResponse get_sections_for_course(id, opts)
1682
+
1683
+
1684
+
1685
+ Returns the sections for a Courses
1686
+
1687
+ ### Example
1688
+ ```ruby
1689
+ # load the gem
1690
+ require 'clever-ruby'
1691
+ # setup authorization
1692
+ Clever.configure do |config|
1693
+ # Configure OAuth2 access token for authorization: oauth
1694
+ config.access_token = 'YOUR ACCESS TOKEN'
1695
+ end
1696
+
1697
+ api_instance = Clever::DataApi.new
1698
+ id = 'id_example' # String |
1699
+ opts = {
1700
+ limit: 56, # Integer |
1701
+ starting_after: 'starting_after_example', # String |
1702
+ ending_before: 'ending_before_example' # String |
1703
+ }
1704
+
1705
+ begin
1706
+ result = api_instance.get_sections_for_course(id, opts)
1707
+ p result
1708
+ rescue Clever::ApiError => e
1709
+ puts "Exception when calling DataApi->get_sections_for_course: #{e}"
1710
+ end
1711
+ ```
1712
+
1713
+ ### Parameters
1714
+
1715
+ Name | Type | Description | Notes
1716
+ ------------- | ------------- | ------------- | -------------
1717
+ **id** | **String**| |
1718
+ **limit** | **Integer**| | [optional]
1719
+ **starting_after** | **String**| | [optional]
1720
+ **ending_before** | **String**| | [optional]
1721
+
1722
+ ### Return type
1723
+
1724
+ [**SectionsResponse**](SectionsResponse.md)
1725
+
1726
+ ### Authorization
1727
+
1728
+ [oauth](../README.md#oauth)
1729
+
1730
+ ### HTTP request headers
1731
+
1732
+ - **Content-Type**: Not defined
1733
+ - **Accept**: application/json
1734
+
1735
+
1736
+
1737
+ # **get_sections_for_school**
1738
+ > SectionsResponse get_sections_for_school(id, opts)
1739
+
1740
+
1741
+
1742
+ Returns the sections for a school
1743
+
1744
+ ### Example
1745
+ ```ruby
1746
+ # load the gem
1747
+ require 'clever-ruby'
1748
+ # setup authorization
1749
+ Clever.configure do |config|
1750
+ # Configure OAuth2 access token for authorization: oauth
1751
+ config.access_token = 'YOUR ACCESS TOKEN'
1752
+ end
1753
+
1754
+ api_instance = Clever::DataApi.new
1755
+ id = 'id_example' # String |
1756
+ opts = {
1757
+ limit: 56, # Integer |
1758
+ starting_after: 'starting_after_example', # String |
1759
+ ending_before: 'ending_before_example' # String |
1760
+ }
1761
+
1762
+ begin
1763
+ result = api_instance.get_sections_for_school(id, opts)
1764
+ p result
1765
+ rescue Clever::ApiError => e
1766
+ puts "Exception when calling DataApi->get_sections_for_school: #{e}"
1767
+ end
1768
+ ```
1769
+
1770
+ ### Parameters
1771
+
1772
+ Name | Type | Description | Notes
1773
+ ------------- | ------------- | ------------- | -------------
1774
+ **id** | **String**| |
1775
+ **limit** | **Integer**| | [optional]
1776
+ **starting_after** | **String**| | [optional]
1777
+ **ending_before** | **String**| | [optional]
1778
+
1779
+ ### Return type
1780
+
1781
+ [**SectionsResponse**](SectionsResponse.md)
1782
+
1783
+ ### Authorization
1784
+
1785
+ [oauth](../README.md#oauth)
1786
+
1787
+ ### HTTP request headers
1788
+
1789
+ - **Content-Type**: Not defined
1790
+ - **Accept**: application/json
1791
+
1792
+
1793
+
1794
+ # **get_sections_for_student**
1795
+ > SectionsResponse get_sections_for_student(id, opts)
1796
+
1797
+
1798
+
1799
+ Returns the sections for a student
1800
+
1801
+ ### Example
1802
+ ```ruby
1803
+ # load the gem
1804
+ require 'clever-ruby'
1805
+ # setup authorization
1806
+ Clever.configure do |config|
1807
+ # Configure OAuth2 access token for authorization: oauth
1808
+ config.access_token = 'YOUR ACCESS TOKEN'
1809
+ end
1810
+
1811
+ api_instance = Clever::DataApi.new
1812
+ id = 'id_example' # String |
1813
+ opts = {
1814
+ limit: 56, # Integer |
1815
+ starting_after: 'starting_after_example', # String |
1816
+ ending_before: 'ending_before_example' # String |
1817
+ }
1818
+
1819
+ begin
1820
+ result = api_instance.get_sections_for_student(id, opts)
1821
+ p result
1822
+ rescue Clever::ApiError => e
1823
+ puts "Exception when calling DataApi->get_sections_for_student: #{e}"
1824
+ end
1825
+ ```
1826
+
1827
+ ### Parameters
1828
+
1829
+ Name | Type | Description | Notes
1830
+ ------------- | ------------- | ------------- | -------------
1831
+ **id** | **String**| |
1832
+ **limit** | **Integer**| | [optional]
1833
+ **starting_after** | **String**| | [optional]
1834
+ **ending_before** | **String**| | [optional]
1835
+
1836
+ ### Return type
1837
+
1838
+ [**SectionsResponse**](SectionsResponse.md)
1839
+
1840
+ ### Authorization
1841
+
1842
+ [oauth](../README.md#oauth)
1843
+
1844
+ ### HTTP request headers
1845
+
1846
+ - **Content-Type**: Not defined
1847
+ - **Accept**: application/json
1848
+
1849
+
1850
+
1851
+ # **get_sections_for_teacher**
1852
+ > SectionsResponse get_sections_for_teacher(id, opts)
1853
+
1854
+
1855
+
1856
+ Returns the sections for a teacher
1857
+
1858
+ ### Example
1859
+ ```ruby
1860
+ # load the gem
1861
+ require 'clever-ruby'
1862
+ # setup authorization
1863
+ Clever.configure do |config|
1864
+ # Configure OAuth2 access token for authorization: oauth
1865
+ config.access_token = 'YOUR ACCESS TOKEN'
1866
+ end
1867
+
1868
+ api_instance = Clever::DataApi.new
1869
+ id = 'id_example' # String |
1870
+ opts = {
1871
+ limit: 56, # Integer |
1872
+ starting_after: 'starting_after_example', # String |
1873
+ ending_before: 'ending_before_example' # String |
1874
+ }
1875
+
1876
+ begin
1877
+ result = api_instance.get_sections_for_teacher(id, opts)
1878
+ p result
1879
+ rescue Clever::ApiError => e
1880
+ puts "Exception when calling DataApi->get_sections_for_teacher: #{e}"
1881
+ end
1882
+ ```
1883
+
1884
+ ### Parameters
1885
+
1886
+ Name | Type | Description | Notes
1887
+ ------------- | ------------- | ------------- | -------------
1888
+ **id** | **String**| |
1889
+ **limit** | **Integer**| | [optional]
1890
+ **starting_after** | **String**| | [optional]
1891
+ **ending_before** | **String**| | [optional]
1892
+
1893
+ ### Return type
1894
+
1895
+ [**SectionsResponse**](SectionsResponse.md)
1896
+
1897
+ ### Authorization
1898
+
1899
+ [oauth](../README.md#oauth)
1900
+
1901
+ ### HTTP request headers
1902
+
1903
+ - **Content-Type**: Not defined
1904
+ - **Accept**: application/json
1905
+
1906
+
1907
+
1908
+ # **get_sections_for_term**
1909
+ > SectionsResponse get_sections_for_term(id, opts)
1910
+
1911
+
1912
+
1913
+ Returns the sections for a term
1914
+
1915
+ ### Example
1916
+ ```ruby
1917
+ # load the gem
1918
+ require 'clever-ruby'
1919
+ # setup authorization
1920
+ Clever.configure do |config|
1921
+ # Configure OAuth2 access token for authorization: oauth
1922
+ config.access_token = 'YOUR ACCESS TOKEN'
1923
+ end
1924
+
1925
+ api_instance = Clever::DataApi.new
1926
+ id = 'id_example' # String |
1927
+ opts = {
1928
+ limit: 56, # Integer |
1929
+ starting_after: 'starting_after_example', # String |
1930
+ ending_before: 'ending_before_example' # String |
1931
+ }
1932
+
1933
+ begin
1934
+ result = api_instance.get_sections_for_term(id, opts)
1935
+ p result
1936
+ rescue Clever::ApiError => e
1937
+ puts "Exception when calling DataApi->get_sections_for_term: #{e}"
1938
+ end
1939
+ ```
1940
+
1941
+ ### Parameters
1942
+
1943
+ Name | Type | Description | Notes
1944
+ ------------- | ------------- | ------------- | -------------
1945
+ **id** | **String**| |
1946
+ **limit** | **Integer**| | [optional]
1947
+ **starting_after** | **String**| | [optional]
1948
+ **ending_before** | **String**| | [optional]
1949
+
1950
+ ### Return type
1951
+
1952
+ [**SectionsResponse**](SectionsResponse.md)
1953
+
1954
+ ### Authorization
1955
+
1956
+ [oauth](../README.md#oauth)
1957
+
1958
+ ### HTTP request headers
1959
+
1960
+ - **Content-Type**: Not defined
1961
+ - **Accept**: application/json
1962
+
1963
+
1964
+
1965
+ # **get_student**
1966
+ > StudentResponse get_student(id)
1967
+
1968
+
1969
+
1970
+ Returns a specific student
1971
+
1972
+ ### Example
1973
+ ```ruby
1974
+ # load the gem
1975
+ require 'clever-ruby'
1976
+ # setup authorization
1977
+ Clever.configure do |config|
1978
+ # Configure OAuth2 access token for authorization: oauth
1979
+ config.access_token = 'YOUR ACCESS TOKEN'
1980
+ end
1981
+
1982
+ api_instance = Clever::DataApi.new
1983
+ id = 'id_example' # String |
1984
+
1985
+
1986
+ begin
1987
+ result = api_instance.get_student(id)
1988
+ p result
1989
+ rescue Clever::ApiError => e
1990
+ puts "Exception when calling DataApi->get_student: #{e}"
1991
+ end
1992
+ ```
1993
+
1994
+ ### Parameters
1995
+
1996
+ Name | Type | Description | Notes
1997
+ ------------- | ------------- | ------------- | -------------
1998
+ **id** | **String**| |
1999
+
2000
+ ### Return type
2001
+
2002
+ [**StudentResponse**](StudentResponse.md)
2003
+
2004
+ ### Authorization
2005
+
2006
+ [oauth](../README.md#oauth)
2007
+
2008
+ ### HTTP request headers
2009
+
2010
+ - **Content-Type**: Not defined
2011
+ - **Accept**: application/json
2012
+
2013
+
2014
+
2015
+ # **get_students**
2016
+ > StudentsResponse get_students(opts)
2017
+
2018
+
2019
+
2020
+ Returns a list of students
2021
+
2022
+ ### Example
2023
+ ```ruby
2024
+ # load the gem
2025
+ require 'clever-ruby'
2026
+ # setup authorization
2027
+ Clever.configure do |config|
2028
+ # Configure OAuth2 access token for authorization: oauth
2029
+ config.access_token = 'YOUR ACCESS TOKEN'
2030
+ end
2031
+
2032
+ api_instance = Clever::DataApi.new
2033
+ opts = {
2034
+ limit: 56, # Integer |
2035
+ starting_after: 'starting_after_example', # String |
2036
+ ending_before: 'ending_before_example', # String |
2037
+ count: 'count_example' # String |
2038
+ }
2039
+
2040
+ begin
2041
+ result = api_instance.get_students(opts)
2042
+ p result
2043
+ rescue Clever::ApiError => e
2044
+ puts "Exception when calling DataApi->get_students: #{e}"
2045
+ end
2046
+ ```
2047
+
2048
+ ### Parameters
2049
+
2050
+ Name | Type | Description | Notes
2051
+ ------------- | ------------- | ------------- | -------------
2052
+ **limit** | **Integer**| | [optional]
2053
+ **starting_after** | **String**| | [optional]
2054
+ **ending_before** | **String**| | [optional]
2055
+ **count** | **String**| | [optional]
2056
+
2057
+ ### Return type
2058
+
2059
+ [**StudentsResponse**](StudentsResponse.md)
2060
+
2061
+ ### Authorization
2062
+
2063
+ [oauth](../README.md#oauth)
2064
+
2065
+ ### HTTP request headers
2066
+
2067
+ - **Content-Type**: Not defined
2068
+ - **Accept**: application/json
2069
+
2070
+
2071
+
2072
+ # **get_students_for_contact**
2073
+ > StudentsResponse get_students_for_contact(id, opts)
2074
+
2075
+
2076
+
2077
+ Returns the students for a student contact
2078
+
2079
+ ### Example
2080
+ ```ruby
2081
+ # load the gem
2082
+ require 'clever-ruby'
2083
+ # setup authorization
2084
+ Clever.configure do |config|
2085
+ # Configure OAuth2 access token for authorization: oauth
2086
+ config.access_token = 'YOUR ACCESS TOKEN'
2087
+ end
2088
+
2089
+ api_instance = Clever::DataApi.new
2090
+ id = 'id_example' # String |
2091
+ opts = {
2092
+ limit: 56, # Integer |
2093
+ starting_after: 'starting_after_example', # String |
2094
+ ending_before: 'ending_before_example' # String |
2095
+ }
2096
+
2097
+ begin
2098
+ result = api_instance.get_students_for_contact(id, opts)
2099
+ p result
2100
+ rescue Clever::ApiError => e
2101
+ puts "Exception when calling DataApi->get_students_for_contact: #{e}"
2102
+ end
2103
+ ```
2104
+
2105
+ ### Parameters
2106
+
2107
+ Name | Type | Description | Notes
2108
+ ------------- | ------------- | ------------- | -------------
2109
+ **id** | **String**| |
2110
+ **limit** | **Integer**| | [optional]
2111
+ **starting_after** | **String**| | [optional]
2112
+ **ending_before** | **String**| | [optional]
2113
+
2114
+ ### Return type
2115
+
2116
+ [**StudentsResponse**](StudentsResponse.md)
2117
+
2118
+ ### Authorization
2119
+
2120
+ [oauth](../README.md#oauth)
2121
+
2122
+ ### HTTP request headers
2123
+
2124
+ - **Content-Type**: Not defined
2125
+ - **Accept**: application/json
2126
+
2127
+
2128
+
2129
+ # **get_students_for_school**
2130
+ > StudentsResponse get_students_for_school(id, opts)
2131
+
2132
+
2133
+
2134
+ Returns the students for a school
2135
+
2136
+ ### Example
2137
+ ```ruby
2138
+ # load the gem
2139
+ require 'clever-ruby'
2140
+ # setup authorization
2141
+ Clever.configure do |config|
2142
+ # Configure OAuth2 access token for authorization: oauth
2143
+ config.access_token = 'YOUR ACCESS TOKEN'
2144
+ end
2145
+
2146
+ api_instance = Clever::DataApi.new
2147
+ id = 'id_example' # String |
2148
+ opts = {
2149
+ limit: 56, # Integer |
2150
+ starting_after: 'starting_after_example', # String |
2151
+ ending_before: 'ending_before_example' # String |
2152
+ }
2153
+
2154
+ begin
2155
+ result = api_instance.get_students_for_school(id, opts)
2156
+ p result
2157
+ rescue Clever::ApiError => e
2158
+ puts "Exception when calling DataApi->get_students_for_school: #{e}"
2159
+ end
2160
+ ```
2161
+
2162
+ ### Parameters
2163
+
2164
+ Name | Type | Description | Notes
2165
+ ------------- | ------------- | ------------- | -------------
2166
+ **id** | **String**| |
2167
+ **limit** | **Integer**| | [optional]
2168
+ **starting_after** | **String**| | [optional]
2169
+ **ending_before** | **String**| | [optional]
2170
+
2171
+ ### Return type
2172
+
2173
+ [**StudentsResponse**](StudentsResponse.md)
2174
+
2175
+ ### Authorization
2176
+
2177
+ [oauth](../README.md#oauth)
2178
+
2179
+ ### HTTP request headers
2180
+
2181
+ - **Content-Type**: Not defined
2182
+ - **Accept**: application/json
2183
+
2184
+
2185
+
2186
+ # **get_students_for_section**
2187
+ > StudentsResponse get_students_for_section(id, opts)
2188
+
2189
+
2190
+
2191
+ Returns the students for a section
2192
+
2193
+ ### Example
2194
+ ```ruby
2195
+ # load the gem
2196
+ require 'clever-ruby'
2197
+ # setup authorization
2198
+ Clever.configure do |config|
2199
+ # Configure OAuth2 access token for authorization: oauth
2200
+ config.access_token = 'YOUR ACCESS TOKEN'
2201
+ end
2202
+
2203
+ api_instance = Clever::DataApi.new
2204
+ id = 'id_example' # String |
2205
+ opts = {
2206
+ limit: 56, # Integer |
2207
+ starting_after: 'starting_after_example', # String |
2208
+ ending_before: 'ending_before_example' # String |
2209
+ }
2210
+
2211
+ begin
2212
+ result = api_instance.get_students_for_section(id, opts)
2213
+ p result
2214
+ rescue Clever::ApiError => e
2215
+ puts "Exception when calling DataApi->get_students_for_section: #{e}"
2216
+ end
2217
+ ```
2218
+
2219
+ ### Parameters
2220
+
2221
+ Name | Type | Description | Notes
2222
+ ------------- | ------------- | ------------- | -------------
2223
+ **id** | **String**| |
2224
+ **limit** | **Integer**| | [optional]
2225
+ **starting_after** | **String**| | [optional]
2226
+ **ending_before** | **String**| | [optional]
2227
+
2228
+ ### Return type
2229
+
2230
+ [**StudentsResponse**](StudentsResponse.md)
2231
+
2232
+ ### Authorization
2233
+
2234
+ [oauth](../README.md#oauth)
2235
+
2236
+ ### HTTP request headers
2237
+
2238
+ - **Content-Type**: Not defined
2239
+ - **Accept**: application/json
2240
+
2241
+
2242
+
2243
+ # **get_students_for_teacher**
2244
+ > StudentsResponse get_students_for_teacher(id, opts)
2245
+
2246
+
2247
+
2248
+ Returns the students for a teacher
2249
+
2250
+ ### Example
2251
+ ```ruby
2252
+ # load the gem
2253
+ require 'clever-ruby'
2254
+ # setup authorization
2255
+ Clever.configure do |config|
2256
+ # Configure OAuth2 access token for authorization: oauth
2257
+ config.access_token = 'YOUR ACCESS TOKEN'
2258
+ end
2259
+
2260
+ api_instance = Clever::DataApi.new
2261
+ id = 'id_example' # String |
2262
+ opts = {
2263
+ limit: 56, # Integer |
2264
+ starting_after: 'starting_after_example', # String |
2265
+ ending_before: 'ending_before_example' # String |
2266
+ }
2267
+
2268
+ begin
2269
+ result = api_instance.get_students_for_teacher(id, opts)
2270
+ p result
2271
+ rescue Clever::ApiError => e
2272
+ puts "Exception when calling DataApi->get_students_for_teacher: #{e}"
2273
+ end
2274
+ ```
2275
+
2276
+ ### Parameters
2277
+
2278
+ Name | Type | Description | Notes
2279
+ ------------- | ------------- | ------------- | -------------
2280
+ **id** | **String**| |
2281
+ **limit** | **Integer**| | [optional]
2282
+ **starting_after** | **String**| | [optional]
2283
+ **ending_before** | **String**| | [optional]
2284
+
2285
+ ### Return type
2286
+
2287
+ [**StudentsResponse**](StudentsResponse.md)
2288
+
2289
+ ### Authorization
2290
+
2291
+ [oauth](../README.md#oauth)
2292
+
2293
+ ### HTTP request headers
2294
+
2295
+ - **Content-Type**: Not defined
2296
+ - **Accept**: application/json
2297
+
2298
+
2299
+
2300
+ # **get_teacher**
2301
+ > TeacherResponse get_teacher(id)
2302
+
2303
+
2304
+
2305
+ Returns a specific teacher
2306
+
2307
+ ### Example
2308
+ ```ruby
2309
+ # load the gem
2310
+ require 'clever-ruby'
2311
+ # setup authorization
2312
+ Clever.configure do |config|
2313
+ # Configure OAuth2 access token for authorization: oauth
2314
+ config.access_token = 'YOUR ACCESS TOKEN'
2315
+ end
2316
+
2317
+ api_instance = Clever::DataApi.new
2318
+ id = 'id_example' # String |
2319
+
2320
+
2321
+ begin
2322
+ result = api_instance.get_teacher(id)
2323
+ p result
2324
+ rescue Clever::ApiError => e
2325
+ puts "Exception when calling DataApi->get_teacher: #{e}"
2326
+ end
2327
+ ```
2328
+
2329
+ ### Parameters
2330
+
2331
+ Name | Type | Description | Notes
2332
+ ------------- | ------------- | ------------- | -------------
2333
+ **id** | **String**| |
2334
+
2335
+ ### Return type
2336
+
2337
+ [**TeacherResponse**](TeacherResponse.md)
2338
+
2339
+ ### Authorization
2340
+
2341
+ [oauth](../README.md#oauth)
2342
+
2343
+ ### HTTP request headers
2344
+
2345
+ - **Content-Type**: Not defined
2346
+ - **Accept**: application/json
2347
+
2348
+
2349
+
2350
+ # **get_teacher_for_section**
2351
+ > TeacherResponse get_teacher_for_section(id)
2352
+
2353
+
2354
+
2355
+ Returns the primary teacher for a section
2356
+
2357
+ ### Example
2358
+ ```ruby
2359
+ # load the gem
2360
+ require 'clever-ruby'
2361
+ # setup authorization
2362
+ Clever.configure do |config|
2363
+ # Configure OAuth2 access token for authorization: oauth
2364
+ config.access_token = 'YOUR ACCESS TOKEN'
2365
+ end
2366
+
2367
+ api_instance = Clever::DataApi.new
2368
+ id = 'id_example' # String |
2369
+
2370
+
2371
+ begin
2372
+ result = api_instance.get_teacher_for_section(id)
2373
+ p result
2374
+ rescue Clever::ApiError => e
2375
+ puts "Exception when calling DataApi->get_teacher_for_section: #{e}"
2376
+ end
2377
+ ```
2378
+
2379
+ ### Parameters
2380
+
2381
+ Name | Type | Description | Notes
2382
+ ------------- | ------------- | ------------- | -------------
2383
+ **id** | **String**| |
2384
+
2385
+ ### Return type
2386
+
2387
+ [**TeacherResponse**](TeacherResponse.md)
2388
+
2389
+ ### Authorization
2390
+
2391
+ [oauth](../README.md#oauth)
2392
+
2393
+ ### HTTP request headers
2394
+
2395
+ - **Content-Type**: Not defined
2396
+ - **Accept**: application/json
2397
+
2398
+
2399
+
2400
+ # **get_teachers**
2401
+ > TeachersResponse get_teachers(opts)
2402
+
2403
+
2404
+
2405
+ Returns a list of teachers
2406
+
2407
+ ### Example
2408
+ ```ruby
2409
+ # load the gem
2410
+ require 'clever-ruby'
2411
+ # setup authorization
2412
+ Clever.configure do |config|
2413
+ # Configure OAuth2 access token for authorization: oauth
2414
+ config.access_token = 'YOUR ACCESS TOKEN'
2415
+ end
2416
+
2417
+ api_instance = Clever::DataApi.new
2418
+ opts = {
2419
+ limit: 56, # Integer |
2420
+ starting_after: 'starting_after_example', # String |
2421
+ ending_before: 'ending_before_example', # String |
2422
+ count: 'count_example' # String |
2423
+ }
2424
+
2425
+ begin
2426
+ result = api_instance.get_teachers(opts)
2427
+ p result
2428
+ rescue Clever::ApiError => e
2429
+ puts "Exception when calling DataApi->get_teachers: #{e}"
2430
+ end
2431
+ ```
2432
+
2433
+ ### Parameters
2434
+
2435
+ Name | Type | Description | Notes
2436
+ ------------- | ------------- | ------------- | -------------
2437
+ **limit** | **Integer**| | [optional]
2438
+ **starting_after** | **String**| | [optional]
2439
+ **ending_before** | **String**| | [optional]
2440
+ **count** | **String**| | [optional]
2441
+
2442
+ ### Return type
2443
+
2444
+ [**TeachersResponse**](TeachersResponse.md)
2445
+
2446
+ ### Authorization
2447
+
2448
+ [oauth](../README.md#oauth)
2449
+
2450
+ ### HTTP request headers
2451
+
2452
+ - **Content-Type**: Not defined
2453
+ - **Accept**: application/json
2454
+
2455
+
2456
+
2457
+ # **get_teachers_for_school**
2458
+ > TeachersResponse get_teachers_for_school(id, opts)
2459
+
2460
+
2461
+
2462
+ Returns the teachers for a school
2463
+
2464
+ ### Example
2465
+ ```ruby
2466
+ # load the gem
2467
+ require 'clever-ruby'
2468
+ # setup authorization
2469
+ Clever.configure do |config|
2470
+ # Configure OAuth2 access token for authorization: oauth
2471
+ config.access_token = 'YOUR ACCESS TOKEN'
2472
+ end
2473
+
2474
+ api_instance = Clever::DataApi.new
2475
+ id = 'id_example' # String |
2476
+ opts = {
2477
+ limit: 56, # Integer |
2478
+ starting_after: 'starting_after_example', # String |
2479
+ ending_before: 'ending_before_example' # String |
2480
+ }
2481
+
2482
+ begin
2483
+ result = api_instance.get_teachers_for_school(id, opts)
2484
+ p result
2485
+ rescue Clever::ApiError => e
2486
+ puts "Exception when calling DataApi->get_teachers_for_school: #{e}"
2487
+ end
2488
+ ```
2489
+
2490
+ ### Parameters
2491
+
2492
+ Name | Type | Description | Notes
2493
+ ------------- | ------------- | ------------- | -------------
2494
+ **id** | **String**| |
2495
+ **limit** | **Integer**| | [optional]
2496
+ **starting_after** | **String**| | [optional]
2497
+ **ending_before** | **String**| | [optional]
2498
+
2499
+ ### Return type
2500
+
2501
+ [**TeachersResponse**](TeachersResponse.md)
2502
+
2503
+ ### Authorization
2504
+
2505
+ [oauth](../README.md#oauth)
2506
+
2507
+ ### HTTP request headers
2508
+
2509
+ - **Content-Type**: Not defined
2510
+ - **Accept**: application/json
2511
+
2512
+
2513
+
2514
+ # **get_teachers_for_section**
2515
+ > TeachersResponse get_teachers_for_section(id, opts)
2516
+
2517
+
2518
+
2519
+ Returns the teachers for a section
2520
+
2521
+ ### Example
2522
+ ```ruby
2523
+ # load the gem
2524
+ require 'clever-ruby'
2525
+ # setup authorization
2526
+ Clever.configure do |config|
2527
+ # Configure OAuth2 access token for authorization: oauth
2528
+ config.access_token = 'YOUR ACCESS TOKEN'
2529
+ end
2530
+
2531
+ api_instance = Clever::DataApi.new
2532
+ id = 'id_example' # String |
2533
+ opts = {
2534
+ limit: 56, # Integer |
2535
+ starting_after: 'starting_after_example', # String |
2536
+ ending_before: 'ending_before_example' # String |
2537
+ }
2538
+
2539
+ begin
2540
+ result = api_instance.get_teachers_for_section(id, opts)
2541
+ p result
2542
+ rescue Clever::ApiError => e
2543
+ puts "Exception when calling DataApi->get_teachers_for_section: #{e}"
2544
+ end
2545
+ ```
2546
+
2547
+ ### Parameters
2548
+
2549
+ Name | Type | Description | Notes
2550
+ ------------- | ------------- | ------------- | -------------
2551
+ **id** | **String**| |
2552
+ **limit** | **Integer**| | [optional]
2553
+ **starting_after** | **String**| | [optional]
2554
+ **ending_before** | **String**| | [optional]
2555
+
2556
+ ### Return type
2557
+
2558
+ [**TeachersResponse**](TeachersResponse.md)
2559
+
2560
+ ### Authorization
2561
+
2562
+ [oauth](../README.md#oauth)
2563
+
2564
+ ### HTTP request headers
2565
+
2566
+ - **Content-Type**: Not defined
2567
+ - **Accept**: application/json
2568
+
2569
+
2570
+
2571
+ # **get_teachers_for_student**
2572
+ > TeachersResponse get_teachers_for_student(id, opts)
2573
+
2574
+
2575
+
2576
+ Returns the teachers for a student
2577
+
2578
+ ### Example
2579
+ ```ruby
2580
+ # load the gem
2581
+ require 'clever-ruby'
2582
+ # setup authorization
2583
+ Clever.configure do |config|
2584
+ # Configure OAuth2 access token for authorization: oauth
2585
+ config.access_token = 'YOUR ACCESS TOKEN'
2586
+ end
2587
+
2588
+ api_instance = Clever::DataApi.new
2589
+ id = 'id_example' # String |
2590
+ opts = {
2591
+ limit: 56, # Integer |
2592
+ starting_after: 'starting_after_example', # String |
2593
+ ending_before: 'ending_before_example' # String |
2594
+ }
2595
+
2596
+ begin
2597
+ result = api_instance.get_teachers_for_student(id, opts)
2598
+ p result
2599
+ rescue Clever::ApiError => e
2600
+ puts "Exception when calling DataApi->get_teachers_for_student: #{e}"
2601
+ end
2602
+ ```
2603
+
2604
+ ### Parameters
2605
+
2606
+ Name | Type | Description | Notes
2607
+ ------------- | ------------- | ------------- | -------------
2608
+ **id** | **String**| |
2609
+ **limit** | **Integer**| | [optional]
2610
+ **starting_after** | **String**| | [optional]
2611
+ **ending_before** | **String**| | [optional]
2612
+
2613
+ ### Return type
2614
+
2615
+ [**TeachersResponse**](TeachersResponse.md)
2616
+
2617
+ ### Authorization
2618
+
2619
+ [oauth](../README.md#oauth)
2620
+
2621
+ ### HTTP request headers
2622
+
2623
+ - **Content-Type**: Not defined
2624
+ - **Accept**: application/json
2625
+
2626
+
2627
+
2628
+ # **get_term**
2629
+ > TermResponse get_term(id)
2630
+
2631
+
2632
+
2633
+ Returns a specific term
2634
+
2635
+ ### Example
2636
+ ```ruby
2637
+ # load the gem
2638
+ require 'clever-ruby'
2639
+ # setup authorization
2640
+ Clever.configure do |config|
2641
+ # Configure OAuth2 access token for authorization: oauth
2642
+ config.access_token = 'YOUR ACCESS TOKEN'
2643
+ end
2644
+
2645
+ api_instance = Clever::DataApi.new
2646
+ id = 'id_example' # String |
2647
+
2648
+
2649
+ begin
2650
+ result = api_instance.get_term(id)
2651
+ p result
2652
+ rescue Clever::ApiError => e
2653
+ puts "Exception when calling DataApi->get_term: #{e}"
2654
+ end
2655
+ ```
2656
+
2657
+ ### Parameters
2658
+
2659
+ Name | Type | Description | Notes
2660
+ ------------- | ------------- | ------------- | -------------
2661
+ **id** | **String**| |
2662
+
2663
+ ### Return type
2664
+
2665
+ [**TermResponse**](TermResponse.md)
2666
+
2667
+ ### Authorization
2668
+
2669
+ [oauth](../README.md#oauth)
2670
+
2671
+ ### HTTP request headers
2672
+
2673
+ - **Content-Type**: Not defined
2674
+ - **Accept**: application/json
2675
+
2676
+
2677
+
2678
+ # **get_term_for_section**
2679
+ > TermResponse get_term_for_section(id)
2680
+
2681
+
2682
+
2683
+ Returns the term for a section
2684
+
2685
+ ### Example
2686
+ ```ruby
2687
+ # load the gem
2688
+ require 'clever-ruby'
2689
+ # setup authorization
2690
+ Clever.configure do |config|
2691
+ # Configure OAuth2 access token for authorization: oauth
2692
+ config.access_token = 'YOUR ACCESS TOKEN'
2693
+ end
2694
+
2695
+ api_instance = Clever::DataApi.new
2696
+ id = 'id_example' # String |
2697
+
2698
+
2699
+ begin
2700
+ result = api_instance.get_term_for_section(id)
2701
+ p result
2702
+ rescue Clever::ApiError => e
2703
+ puts "Exception when calling DataApi->get_term_for_section: #{e}"
2704
+ end
2705
+ ```
2706
+
2707
+ ### Parameters
2708
+
2709
+ Name | Type | Description | Notes
2710
+ ------------- | ------------- | ------------- | -------------
2711
+ **id** | **String**| |
2712
+
2713
+ ### Return type
2714
+
2715
+ [**TermResponse**](TermResponse.md)
2716
+
2717
+ ### Authorization
2718
+
2719
+ [oauth](../README.md#oauth)
2720
+
2721
+ ### HTTP request headers
2722
+
2723
+ - **Content-Type**: Not defined
2724
+ - **Accept**: application/json
2725
+
2726
+
2727
+
2728
+ # **get_terms**
2729
+ > TermsResponse get_terms(opts)
2730
+
2731
+
2732
+
2733
+ Returns a list of terms
2734
+
2735
+ ### Example
2736
+ ```ruby
2737
+ # load the gem
2738
+ require 'clever-ruby'
2739
+ # setup authorization
2740
+ Clever.configure do |config|
2741
+ # Configure OAuth2 access token for authorization: oauth
2742
+ config.access_token = 'YOUR ACCESS TOKEN'
2743
+ end
2744
+
2745
+ api_instance = Clever::DataApi.new
2746
+ opts = {
2747
+ limit: 56, # Integer |
2748
+ starting_after: 'starting_after_example', # String |
2749
+ ending_before: 'ending_before_example', # String |
2750
+ count: 'count_example' # String |
2751
+ }
2752
+
2753
+ begin
2754
+ result = api_instance.get_terms(opts)
2755
+ p result
2756
+ rescue Clever::ApiError => e
2757
+ puts "Exception when calling DataApi->get_terms: #{e}"
2758
+ end
2759
+ ```
2760
+
2761
+ ### Parameters
2762
+
2763
+ Name | Type | Description | Notes
2764
+ ------------- | ------------- | ------------- | -------------
2765
+ **limit** | **Integer**| | [optional]
2766
+ **starting_after** | **String**| | [optional]
2767
+ **ending_before** | **String**| | [optional]
2768
+ **count** | **String**| | [optional]
2769
+
2770
+ ### Return type
2771
+
2772
+ [**TermsResponse**](TermsResponse.md)
2773
+
2774
+ ### Authorization
2775
+
2776
+ [oauth](../README.md#oauth)
2777
+
2778
+ ### HTTP request headers
2779
+
2780
+ - **Content-Type**: Not defined
2781
+ - **Accept**: application/json
2782
+
2783
+
2784
+