commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

data/docs/CoursesApi.md

@@ -0,0 +1,231 @@
+# Clever::CoursesApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_course**](CoursesApi.md#get_course) | **GET** /courses/{id} | 
+[**get_courses**](CoursesApi.md#get_courses) | **GET** /courses | 
+[**get_district_for_course**](CoursesApi.md#get_district_for_course) | **GET** /courses/{id}/district | 
+[**get_sections_for_course**](CoursesApi.md#get_sections_for_course) | **GET** /courses/{id}/sections | 
+
+
+# **get_course**
+> CourseResponse get_course(id)
+
+
+
+Returns a specific course
+
+### 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::CoursesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_course(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling CoursesApi->get_course: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**CourseResponse**](CourseResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_courses**
+> CoursesResponse get_courses(opts)
+
+
+
+Returns a list of courses
+
+### 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::CoursesApi.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_courses(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling CoursesApi->get_courses: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**CoursesResponse**](CoursesResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_district_for_course**
+> DistrictResponse get_district_for_course(id)
+
+
+
+Returns the district for a course
+
+### 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::CoursesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_course(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling CoursesApi->get_district_for_course: #{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_course**
+> SectionsResponse get_sections_for_course(id, opts)
+
+
+
+Returns the sections for a Courses
+
+### 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::CoursesApi.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_course(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling CoursesApi->get_sections_for_course: #{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
+
+
+

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

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

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

data/docs/District.md

@@ -3,19 +3,19 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**district_contact** | [**DistrictAdmin**](DistrictAdmin.md) |  | [optional] 
-**error** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
-**last_sync** | **String** |  | [optional] 
-**launch_date** | **String** |  | [optional] 
-**login_methods** | **Array<String>** |  | [optional] 
-**mdr_number** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**mdr_number** | **String** |  | [optional] 
 **nces_id** | **String** |  | [optional] 
-**pause_end** | **String** |  | [optional] 
-**pause_start** | **String** |  | [optional] 
-**portal_url** | **String** |  | [optional] 
 **sis_type** | **String** |  | [optional] 
 **state** | **String** |  | [optional] 
+**last_sync** | **String** |  | [optional] 
+**error** | **String** |  | [optional] 
+**pause_start** | **String** |  | [optional] 
+**pause_end** | **String** |  | [optional] 
+**launch_date** | **String** |  | [optional] 
+**portal_url** | **String** |  | [optional] 
+**login_methods** | **Array<String>** |  | [optional] 
+**district_contact** | [**DistrictAdmin**](DistrictAdmin.md) |  | [optional] 
 
 

data/docs/DistrictAdmin.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**district** | **String** |  | [optional] 
-**email** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
 **name** | [**AdminName**](AdminName.md) |  | [optional] 
+**email** | **String** |  | [optional] 
 **title** | **String** |  | [optional] 
+**district** | **String** |  | [optional] 
 
 

data/docs/DistrictAdminsApi.md

@@ -0,0 +1,171 @@
+# Clever::DistrictAdminsApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district_admin**](DistrictAdminsApi.md#get_district_admin) | **GET** /district_admins/{id} | 
+[**get_district_admins**](DistrictAdminsApi.md#get_district_admins) | **GET** /district_admins | 
+[**get_district_for_district_admin**](DistrictAdminsApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district | 
+
+
+# **get_district_admin**
+> DistrictAdminResponse get_district_admin(id)
+
+
+
+Returns a specific district 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::DistrictAdminsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_admin(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling DistrictAdminsApi->get_district_admin: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**DistrictAdminResponse**](DistrictAdminResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_district_admins**
+> DistrictAdminsResponse get_district_admins(opts)
+
+
+
+Returns a list of district 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::DistrictAdminsApi.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_district_admins(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling DistrictAdminsApi->get_district_admins: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**DistrictAdminsResponse**](DistrictAdminsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_district_for_district_admin**
+> DistrictResponse get_district_for_district_admin(id)
+
+
+
+Returns the district for a district 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::DistrictAdminsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district_for_district_admin(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling DistrictAdminsApi->get_district_for_district_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
+
+
+

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

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

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

data/docs/DistrictsApi.md

@@ -0,0 +1,113 @@
+# Clever::DistrictsApi
+
+All URIs are relative to *https://api.clever.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_district**](DistrictsApi.md#get_district) | **GET** /districts/{id} | 
+[**get_districts**](DistrictsApi.md#get_districts) | **GET** /districts | 
+
+
+# **get_district**
+> DistrictResponse get_district(id)
+
+
+
+Returns a specific district
+
+### 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::DistrictsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_district(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling DistrictsApi->get_district: #{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_districts**
+> DistrictsResponse get_districts(opts)
+
+
+
+Returns a list of districts. In practice this will only return the one district associated with the bearer token
+
+### 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::DistrictsApi.new
+
+opts = { 
+  count: 'count_example' # String | 
+}
+
+begin
+  result = api_instance.get_districts(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling DistrictsApi->get_districts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **count** | **String**|  | [optional] 
+
+### Return type
+
+[**DistrictsResponse**](DistrictsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

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

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

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

data/docs/Event.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created** | **String** |  | [optional] 
-**id** | **String** |  | [optional] 
 **type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 
 

data/docs/EventsApi.md

@@ -1,6 +1,6 @@
 # Clever::EventsApi
 
-All URIs are relative to *https://api.clever.com/v2.1*
+All URIs are relative to *https://api.clever.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/Location.md

@@ -5,9 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address** | **String** |  | [optional] 
 **city** | **String** |  | [optional] 
-**lat** | **String** |  | [optional] 
-**lon** | **String** |  | [optional] 
 **state** | **String** |  | [optional] 
 **zip** | **String** |  | [optional] 
+**lat** | **String** |  | [optional] 
+**lon** | **String** |  | [optional]