commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

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