commonlit-clever-ruby 2.1.3 → 2.1.6.beta1

data/docs/Name.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first** | **String** |  | [optional] 
-**last** | **String** |  | [optional] 
 **middle** | **String** |  | [optional] 
+**last** | **String** |  | [optional] 
 
 

data/docs/Principal.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
 
 

data/docs/School.md

@@ -3,15 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
 **created** | **String** |  | [optional] 
 **district** | **String** |  | [optional] 
-**ext** | **Object** |  | [optional] 
 **high_grade** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **last_modified** | **String** |  | [optional] 
 **location** | [**Location**](Location.md) |  | [optional] 
 **low_grade** | **String** |  | [optional] 
-**mdr_number** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **nces_id** | **String** |  | [optional] 
 **phone** | **String** |  | [optional] 
@@ -19,5 +17,7 @@ Name | Type | Description | Notes
 **school_number** | **String** |  | [optional] 
 **sis_id** | **String** |  | [optional] 
 **state_id** | **String** |  | [optional] 
+**mdr_number** | **String** |  | [optional] 
+**ext** | **Object** |  | [optional] 
 
 

data/docs/SchoolAdmin.md

@@ -3,15 +3,15 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
 **credentials** | [**Credentials**](Credentials.md) |  | [optional] 
-**department** | **String** |  | [optional] 
 **district** | **String** |  | [optional] 
 **email** | **String** |  | [optional] 
-**ext** | **Object** |  | [optional] 
-**id** | **String** |  | [optional] 
 **name** | [**AdminName**](AdminName.md) |  | [optional] 
 **schools** | **Array<String>** |  | [optional] 
 **staff_id** | **String** |  | [optional] 
 **title** | **String** |  | [optional] 
+**department** | **String** |  | [optional] 
+**ext** | **Object** |  | [optional] 
 
 

data/docs/SchoolAdminsApi.md

@@ -0,0 +1,231 @@
+# Clever::SchoolAdminsApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district_for_school_admin**](SchoolAdminsApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district | 
+[**get_school_admin**](SchoolAdminsApi.md#get_school_admin) | **GET** /school_admins/{id} | 
+[**get_school_admins**](SchoolAdminsApi.md#get_school_admins) | **GET** /school_admins | 
+[**get_schools_for_school_admin**](SchoolAdminsApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools | 
+
+
+# **get_district_for_school_admin**
+> DistrictResponse get_district_for_school_admin(id)
+
+
+
+Returns the district for a school admin
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolAdminsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_school_admin(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolAdminsApi->get_district_for_school_admin: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**DistrictResponse**](DistrictResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_school_admin**
+> SchoolAdminResponse get_school_admin(id)
+
+
+
+Returns a specific school admin
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolAdminsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_school_admin(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolAdminsApi->get_school_admin: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**SchoolAdminResponse**](SchoolAdminResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_school_admins**
+> SchoolAdminsResponse get_school_admins(opts)
+
+
+
+Returns a list of school admins
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolAdminsApi.new
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example', # String | 
+  count: 'count_example' # String | 
+}
+
+begin
+  result = api_instance.get_school_admins(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolAdminsApi->get_school_admins: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**SchoolAdminsResponse**](SchoolAdminsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_schools_for_school_admin**
+> SchoolsResponse get_schools_for_school_admin(id, opts)
+
+
+
+Returns the schools for a school admin
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolAdminsApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example' # String | 
+}
+
+begin
+  result = api_instance.get_schools_for_school_admin(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolAdminsApi->get_schools_for_school_admin: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**SchoolsResponse**](SchoolsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SchoolEnrollment.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**end_date** | **String** |  | [optional] 
 **school** | **String** |  | [optional] 
 **start_date** | **String** |  | [optional] 
+**end_date** | **String** |  | [optional] 
 
 

data/docs/SchooladminsCreated.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 **data** | [**SchoolAdminObject**](SchoolAdminObject.md) |  | [optional] 
 
 

data/docs/SchooladminsDeleted.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 **data** | [**SchoolAdminObject**](SchoolAdminObject.md) |  | [optional] 
 
 

data/docs/SchooladminsUpdated.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 **data** | [**SchoolAdminObject**](SchoolAdminObject.md) |  | [optional] 
 **previous_attributes** | **Object** |  | [optional] 
 

data/docs/SchoolsApi.md

@@ -0,0 +1,351 @@
+# Clever::SchoolsApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district_for_school**](SchoolsApi.md#get_district_for_school) | **GET** /schools/{id}/district | 
+[**get_school**](SchoolsApi.md#get_school) | **GET** /schools/{id} | 
+[**get_schools**](SchoolsApi.md#get_schools) | **GET** /schools | 
+[**get_sections_for_school**](SchoolsApi.md#get_sections_for_school) | **GET** /schools/{id}/sections | 
+[**get_students_for_school**](SchoolsApi.md#get_students_for_school) | **GET** /schools/{id}/students | 
+[**get_teachers_for_school**](SchoolsApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers | 
+
+
+# **get_district_for_school**
+> DistrictResponse get_district_for_school(id)
+
+
+
+Returns the district for a school
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_school(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_district_for_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**DistrictResponse**](DistrictResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_school**
+> SchoolResponse get_school(id)
+
+
+
+Returns a specific school
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_school(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**SchoolResponse**](SchoolResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_schools**
+> SchoolsResponse get_schools(opts)
+
+
+
+Returns a list of schools
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example', # String | 
+  count: 'count_example' # String | 
+}
+
+begin
+  result = api_instance.get_schools(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_schools: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**SchoolsResponse**](SchoolsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_sections_for_school**
+> SectionsResponse get_sections_for_school(id, opts)
+
+
+
+Returns the sections for a school
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example' # String | 
+}
+
+begin
+  result = api_instance.get_sections_for_school(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_sections_for_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**SectionsResponse**](SectionsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_students_for_school**
+> StudentsResponse get_students_for_school(id, opts)
+
+
+
+Returns the students for a school
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example' # String | 
+}
+
+begin
+  result = api_instance.get_students_for_school(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_students_for_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**StudentsResponse**](StudentsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_teachers_for_school**
+> TeachersResponse get_teachers_for_school(id, opts)
+
+
+
+Returns the teachers for a school
+
+### Example
+```ruby
+# load the gem
+require 'clever-ruby'
+# setup authorization
+Clever.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Clever::SchoolsApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example' # String | 
+}
+
+begin
+  result = api_instance.get_teachers_for_school(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling SchoolsApi->get_teachers_for_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**TeachersResponse**](TeachersResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SchoolsCreated.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 **data** | [**SchoolObject**](SchoolObject.md) |  | [optional]