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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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/CoursesApi.md DELETED
@@ -1,231 +0,0 @@
1
- # Clever::CoursesApi
2
-
3
- All URIs are relative to *https://api.clever.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_course**](CoursesApi.md#get_course) | **GET** /courses/{id} |
8
- [**get_courses**](CoursesApi.md#get_courses) | **GET** /courses |
9
- [**get_district_for_course**](CoursesApi.md#get_district_for_course) | **GET** /courses/{id}/district |
10
- [**get_sections_for_course**](CoursesApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
11
-
12
-
13
- # **get_course**
14
- > CourseResponse get_course(id)
15
-
16
-
17
-
18
- Returns a specific course
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::CoursesApi.new
31
-
32
- id = 'id_example' # String |
33
-
34
-
35
- begin
36
- result = api_instance.get_course(id)
37
- p result
38
- rescue Clever::ApiError => e
39
- puts "Exception when calling CoursesApi->get_course: #{e}"
40
- end
41
- ```
42
-
43
- ### Parameters
44
-
45
- Name | Type | Description | Notes
46
- ------------- | ------------- | ------------- | -------------
47
- **id** | **String**| |
48
-
49
- ### Return type
50
-
51
- [**CourseResponse**](CourseResponse.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_courses**
65
- > CoursesResponse get_courses(opts)
66
-
67
-
68
-
69
- Returns a list of courses
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::CoursesApi.new
82
-
83
- opts = {
84
- limit: 56, # Integer |
85
- starting_after: 'starting_after_example', # String |
86
- ending_before: 'ending_before_example', # String |
87
- count: 'count_example' # String |
88
- }
89
-
90
- begin
91
- result = api_instance.get_courses(opts)
92
- p result
93
- rescue Clever::ApiError => e
94
- puts "Exception when calling CoursesApi->get_courses: #{e}"
95
- end
96
- ```
97
-
98
- ### Parameters
99
-
100
- Name | Type | Description | Notes
101
- ------------- | ------------- | ------------- | -------------
102
- **limit** | **Integer**| | [optional]
103
- **starting_after** | **String**| | [optional]
104
- **ending_before** | **String**| | [optional]
105
- **count** | **String**| | [optional]
106
-
107
- ### Return type
108
-
109
- [**CoursesResponse**](CoursesResponse.md)
110
-
111
- ### Authorization
112
-
113
- [oauth](../README.md#oauth)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
122
- # **get_district_for_course**
123
- > DistrictResponse get_district_for_course(id)
124
-
125
-
126
-
127
- Returns the district for a course
128
-
129
- ### Example
130
- ```ruby
131
- # load the gem
132
- require 'clever-ruby'
133
- # setup authorization
134
- Clever.configure do |config|
135
- # Configure OAuth2 access token for authorization: oauth
136
- config.access_token = 'YOUR ACCESS TOKEN'
137
- end
138
-
139
- api_instance = Clever::CoursesApi.new
140
-
141
- id = 'id_example' # String |
142
-
143
-
144
- begin
145
- result = api_instance.get_district_for_course(id)
146
- p result
147
- rescue Clever::ApiError => e
148
- puts "Exception when calling CoursesApi->get_district_for_course: #{e}"
149
- end
150
- ```
151
-
152
- ### Parameters
153
-
154
- Name | Type | Description | Notes
155
- ------------- | ------------- | ------------- | -------------
156
- **id** | **String**| |
157
-
158
- ### Return type
159
-
160
- [**DistrictResponse**](DistrictResponse.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_sections_for_course**
174
- > SectionsResponse get_sections_for_course(id, opts)
175
-
176
-
177
-
178
- Returns the sections for a Courses
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::CoursesApi.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_sections_for_course(id, opts)
202
- p result
203
- rescue Clever::ApiError => e
204
- puts "Exception when calling CoursesApi->get_sections_for_course: #{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
- [**SectionsResponse**](SectionsResponse.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
-
data/docs/DistrictAdminsApi.md DELETED
@@ -1,171 +0,0 @@
1
- # Clever::DistrictAdminsApi
2
-
3
- All URIs are relative to *https://api.clever.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_district_admin**](DistrictAdminsApi.md#get_district_admin) | **GET** /district_admins/{id} |
8
- [**get_district_admins**](DistrictAdminsApi.md#get_district_admins) | **GET** /district_admins |
9
- [**get_district_for_district_admin**](DistrictAdminsApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
10
-
11
-
12
- # **get_district_admin**
13
- > DistrictAdminResponse get_district_admin(id)
14
-
15
-
16
-
17
- Returns a specific district admin
18
-
19
- ### Example
20
- ```ruby
21
- # load the gem
22
- require 'clever-ruby'
23
- # setup authorization
24
- Clever.configure do |config|
25
- # Configure OAuth2 access token for authorization: oauth
26
- config.access_token = 'YOUR ACCESS TOKEN'
27
- end
28
-
29
- api_instance = Clever::DistrictAdminsApi.new
30
-
31
- id = 'id_example' # String |
32
-
33
-
34
- begin
35
- result = api_instance.get_district_admin(id)
36
- p result
37
- rescue Clever::ApiError => e
38
- puts "Exception when calling DistrictAdminsApi->get_district_admin: #{e}"
39
- end
40
- ```
41
-
42
- ### Parameters
43
-
44
- Name | Type | Description | Notes
45
- ------------- | ------------- | ------------- | -------------
46
- **id** | **String**| |
47
-
48
- ### Return type
49
-
50
- [**DistrictAdminResponse**](DistrictAdminResponse.md)
51
-
52
- ### Authorization
53
-
54
- [oauth](../README.md#oauth)
55
-
56
- ### HTTP request headers
57
-
58
- - **Content-Type**: Not defined
59
- - **Accept**: application/json
60
-
61
-
62
-
63
- # **get_district_admins**
64
- > DistrictAdminsResponse get_district_admins(opts)
65
-
66
-
67
-
68
- Returns a list of district admins
69
-
70
- ### Example
71
- ```ruby
72
- # load the gem
73
- require 'clever-ruby'
74
- # setup authorization
75
- Clever.configure do |config|
76
- # Configure OAuth2 access token for authorization: oauth
77
- config.access_token = 'YOUR ACCESS TOKEN'
78
- end
79
-
80
- api_instance = Clever::DistrictAdminsApi.new
81
-
82
- opts = {
83
- limit: 56, # Integer |
84
- starting_after: 'starting_after_example', # String |
85
- ending_before: 'ending_before_example', # String |
86
- count: 'count_example' # String |
87
- }
88
-
89
- begin
90
- result = api_instance.get_district_admins(opts)
91
- p result
92
- rescue Clever::ApiError => e
93
- puts "Exception when calling DistrictAdminsApi->get_district_admins: #{e}"
94
- end
95
- ```
96
-
97
- ### Parameters
98
-
99
- Name | Type | Description | Notes
100
- ------------- | ------------- | ------------- | -------------
101
- **limit** | **Integer**| | [optional]
102
- **starting_after** | **String**| | [optional]
103
- **ending_before** | **String**| | [optional]
104
- **count** | **String**| | [optional]
105
-
106
- ### Return type
107
-
108
- [**DistrictAdminsResponse**](DistrictAdminsResponse.md)
109
-
110
- ### Authorization
111
-
112
- [oauth](../README.md#oauth)
113
-
114
- ### HTTP request headers
115
-
116
- - **Content-Type**: Not defined
117
- - **Accept**: application/json
118
-
119
-
120
-
121
- # **get_district_for_district_admin**
122
- > DistrictResponse get_district_for_district_admin(id)
123
-
124
-
125
-
126
- Returns the district for a district admin
127
-
128
- ### Example
129
- ```ruby
130
- # load the gem
131
- require 'clever-ruby'
132
- # setup authorization
133
- Clever.configure do |config|
134
- # Configure OAuth2 access token for authorization: oauth
135
- config.access_token = 'YOUR ACCESS TOKEN'
136
- end
137
-
138
- api_instance = Clever::DistrictAdminsApi.new
139
-
140
- id = 'id_example' # String |
141
-
142
-
143
- begin
144
- result = api_instance.get_district_for_district_admin(id)
145
- p result
146
- rescue Clever::ApiError => e
147
- puts "Exception when calling DistrictAdminsApi->get_district_for_district_admin: #{e}"
148
- end
149
- ```
150
-
151
- ### Parameters
152
-
153
- Name | Type | Description | Notes
154
- ------------- | ------------- | ------------- | -------------
155
- **id** | **String**| |
156
-
157
- ### Return type
158
-
159
- [**DistrictResponse**](DistrictResponse.md)
160
-
161
- ### Authorization
162
-
163
- [oauth](../README.md#oauth)
164
-
165
- ### HTTP request headers
166
-
167
- - **Content-Type**: Not defined
168
- - **Accept**: application/json
169
-
170
-
171
-
data/docs/DistrictsApi.md DELETED
@@ -1,113 +0,0 @@
1
- # Clever::DistrictsApi
2
-
3
- All URIs are relative to *https://api.clever.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_district**](DistrictsApi.md#get_district) | **GET** /districts/{id} |
8
- [**get_districts**](DistrictsApi.md#get_districts) | **GET** /districts |
9
-
10
-
11
- # **get_district**
12
- > DistrictResponse get_district(id)
13
-
14
-
15
-
16
- Returns a specific district
17
-
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'clever-ruby'
22
- # setup authorization
23
- Clever.configure do |config|
24
- # Configure OAuth2 access token for authorization: oauth
25
- config.access_token = 'YOUR ACCESS TOKEN'
26
- end
27
-
28
- api_instance = Clever::DistrictsApi.new
29
-
30
- id = 'id_example' # String |
31
-
32
-
33
- begin
34
- result = api_instance.get_district(id)
35
- p result
36
- rescue Clever::ApiError => e
37
- puts "Exception when calling DistrictsApi->get_district: #{e}"
38
- end
39
- ```
40
-
41
- ### Parameters
42
-
43
- Name | Type | Description | Notes
44
- ------------- | ------------- | ------------- | -------------
45
- **id** | **String**| |
46
-
47
- ### Return type
48
-
49
- [**DistrictResponse**](DistrictResponse.md)
50
-
51
- ### Authorization
52
-
53
- [oauth](../README.md#oauth)
54
-
55
- ### HTTP request headers
56
-
57
- - **Content-Type**: Not defined
58
- - **Accept**: application/json
59
-
60
-
61
-
62
- # **get_districts**
63
- > DistrictsResponse get_districts(opts)
64
-
65
-
66
-
67
- Returns a list of districts. In practice this will only return the one district associated with the bearer token
68
-
69
- ### Example
70
- ```ruby
71
- # load the gem
72
- require 'clever-ruby'
73
- # setup authorization
74
- Clever.configure do |config|
75
- # Configure OAuth2 access token for authorization: oauth
76
- config.access_token = 'YOUR ACCESS TOKEN'
77
- end
78
-
79
- api_instance = Clever::DistrictsApi.new
80
-
81
- opts = {
82
- count: 'count_example' # String |
83
- }
84
-
85
- begin
86
- result = api_instance.get_districts(opts)
87
- p result
88
- rescue Clever::ApiError => e
89
- puts "Exception when calling DistrictsApi->get_districts: #{e}"
90
- end
91
- ```
92
-
93
- ### Parameters
94
-
95
- Name | Type | Description | Notes
96
- ------------- | ------------- | ------------- | -------------
97
- **count** | **String**| | [optional]
98
-
99
- ### Return type
100
-
101
- [**DistrictsResponse**](DistrictsResponse.md)
102
-
103
- ### Authorization
104
-
105
- [oauth](../README.md#oauth)
106
-
107
- ### HTTP request headers
108
-
109
- - **Content-Type**: Not defined
110
- - **Accept**: application/json
111
-
112
-
113
-