commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

data/docs/TeachersApi.md

@@ -0,0 +1,403 @@
+# Clever::TeachersApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district_for_teacher**](TeachersApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district | 
+[**get_school_for_teacher**](TeachersApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school | 
+[**get_schools_for_teacher**](TeachersApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools | 
+[**get_sections_for_teacher**](TeachersApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections | 
+[**get_students_for_teacher**](TeachersApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students | 
+[**get_teacher**](TeachersApi.md#get_teacher) | **GET** /teachers/{id} | 
+[**get_teachers**](TeachersApi.md#get_teachers) | **GET** /teachers | 
+
+
+# **get_district_for_teacher**
+> DistrictResponse get_district_for_teacher(id)
+
+
+
+Returns the district for a teacher
+
+### 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::TeachersApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_teacher(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_district_for_teacher: #{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_for_teacher**
+> SchoolResponse get_school_for_teacher(id)
+
+
+
+Retrieves school info for a teacher.
+
+### 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::TeachersApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_school_for_teacher(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_school_for_teacher: #{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_for_teacher**
+> SchoolsResponse get_schools_for_teacher(id, opts)
+
+
+
+Returns the schools for a teacher
+
+### 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::TeachersApi.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_teacher(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_schools_for_teacher: #{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
+
+
+
+# **get_sections_for_teacher**
+> SectionsResponse get_sections_for_teacher(id, opts)
+
+
+
+Returns the sections for a teacher
+
+### 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::TeachersApi.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_teacher(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_sections_for_teacher: #{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_teacher**
+> StudentsResponse get_students_for_teacher(id, opts)
+
+
+
+Returns the students for a teacher
+
+### 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::TeachersApi.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_teacher(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_students_for_teacher: #{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_teacher**
+> TeacherResponse get_teacher(id)
+
+
+
+Returns a specific teacher
+
+### 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::TeachersApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_teacher(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_teacher: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**TeacherResponse**](TeacherResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_teachers**
+> TeachersResponse get_teachers(opts)
+
+
+
+Returns a list of teachers
+
+### 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::TeachersApi.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_teachers(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TeachersApi->get_teachers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**TeachersResponse**](TeachersResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TeachersCreated.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** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
 
 

data/docs/TeachersDeleted.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** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
 
 

data/docs/TeachersUpdated.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** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
 **previous_attributes** | **Object** |  | [optional] 
 

data/docs/Term.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**district** | **String** |  | [optional] 
-**end_date** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **start_date** | **String** |  | [optional] 
+**end_date** | **String** |  | [optional] 
+**district** | **String** |  | [optional] 
 
 

data/docs/TermsApi.md

@@ -0,0 +1,231 @@
+# Clever::TermsApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district_for_term**](TermsApi.md#get_district_for_term) | **GET** /terms/{id}/district | 
+[**get_sections_for_term**](TermsApi.md#get_sections_for_term) | **GET** /terms/{id}/sections | 
+[**get_term**](TermsApi.md#get_term) | **GET** /terms/{id} | 
+[**get_terms**](TermsApi.md#get_terms) | **GET** /terms | 
+
+
+# **get_district_for_term**
+> DistrictResponse get_district_for_term(id)
+
+
+
+Returns the district for a term
+
+### 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::TermsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_term(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TermsApi->get_district_for_term: #{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_sections_for_term**
+> SectionsResponse get_sections_for_term(id, opts)
+
+
+
+Returns the sections for a term
+
+### 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::TermsApi.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_term(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TermsApi->get_sections_for_term: #{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_term**
+> TermResponse get_term(id)
+
+
+
+Returns a specific term
+
+### 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::TermsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_term(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TermsApi->get_term: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**TermResponse**](TermResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_terms**
+> TermsResponse get_terms(opts)
+
+
+
+Returns a list of terms
+
+### 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::TermsApi.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_terms(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling TermsApi->get_terms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**TermsResponse**](TermsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TermsCreated.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** | [**TermObject**](TermObject.md) |  | [optional] 
 
 

data/docs/TermsDeleted.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** | [**TermObject**](TermObject.md) |  | [optional] 
 
 

data/docs/TermsUpdated.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** | [**TermObject**](TermObject.md) |  | [optional] 
 **previous_attributes** | **Object** |  | [optional]