commonlit-clever-ruby 2.1.1

data/docs/District.md

@@ -0,0 +1,21 @@
+# Clever::District
+
+## 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] 
+**nces_id** | **String** |  | [optional] 
+**pause_end** | **String** |  | [optional] 
+**pause_start** | **String** |  | [optional] 
+**portal_url** | **String** |  | [optional] 
+**sis_type** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+
+

data/docs/DistrictAdmin.md

@@ -0,0 +1,12 @@
+# Clever::DistrictAdmin
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**district** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**name** | [**AdminName**](AdminName.md) |  | [optional] 
+**title** | **String** |  | [optional] 
+
+

data/docs/DistrictAdminObject.md

@@ -0,0 +1,8 @@
+# Clever::DistrictAdminObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**DistrictAdmin**](DistrictAdmin.md) |  | [optional] 
+
+

data/docs/DistrictAdminResponse.md

@@ -0,0 +1,8 @@
+# Clever::DistrictAdminResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**DistrictAdmin**](DistrictAdmin.md) |  | [optional] 
+
+

data/docs/DistrictAdminsResponse.md

@@ -0,0 +1,9 @@
+# Clever::DistrictAdminsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DistrictAdminResponse>**](DistrictAdminResponse.md) |  | [optional] 
+**links** | [**Array<Link>**](Link.md) |  | [optional] 
+
+

data/docs/DistrictObject.md

@@ -0,0 +1,8 @@
+# Clever::DistrictObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**District**](District.md) |  | [optional] 
+
+

data/docs/DistrictResponse.md

@@ -0,0 +1,8 @@
+# Clever::DistrictResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**District**](District.md) |  | [optional] 
+
+

data/docs/DistrictadminsCreated.md

@@ -0,0 +1,11 @@
+# Clever::DistrictadminsCreated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictAdminObject**](DistrictAdminObject.md) |  | [optional] 
+
+

data/docs/DistrictadminsDeleted.md

@@ -0,0 +1,11 @@
+# Clever::DistrictadminsDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictAdminObject**](DistrictAdminObject.md) |  | [optional] 
+
+

data/docs/DistrictadminsUpdated.md

@@ -0,0 +1,12 @@
+# Clever::DistrictadminsUpdated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictAdminObject**](DistrictAdminObject.md) |  | [optional] 
+**previous_attributes** | **Object** |  | [optional] 
+
+

data/docs/DistrictsCreated.md

@@ -0,0 +1,11 @@
+# Clever::DistrictsCreated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictObject**](DistrictObject.md) |  | [optional] 
+
+

data/docs/DistrictsDeleted.md

@@ -0,0 +1,11 @@
+# Clever::DistrictsDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictObject**](DistrictObject.md) |  | [optional] 
+
+

data/docs/DistrictsResponse.md

@@ -0,0 +1,9 @@
+# Clever::DistrictsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DistrictResponse>**](DistrictResponse.md) |  | [optional] 
+**links** | [**Array<Link>**](Link.md) |  | [optional] 
+
+

data/docs/DistrictsUpdated.md

@@ -0,0 +1,12 @@
+# Clever::DistrictsUpdated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+**data** | [**DistrictObject**](DistrictObject.md) |  | [optional] 
+**previous_attributes** | **Object** |  | [optional] 
+
+

data/docs/Event.md

@@ -0,0 +1,10 @@
+# Clever::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**type** | **String** |  | 
+
+

data/docs/EventResponse.md

@@ -0,0 +1,8 @@
+# Clever::EventResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Event**](Event.md) |  | [optional] 
+
+

data/docs/EventsApi.md

@@ -0,0 +1,121 @@
+# Clever::EventsApi
+
+All URIs are relative to *https://api.clever.com/v2.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_event**](EventsApi.md#get_event) | **GET** /events/{id} | 
+[**get_events**](EventsApi.md#get_events) | **GET** /events | 
+
+
+# **get_event**
+> EventResponse get_event(id)
+
+
+
+Returns the specific event
+
+### 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::EventsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_event(id)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_event: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**EventResponse**](EventResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events**
+> EventsResponse get_events(opts)
+
+
+
+Returns a list of events
+
+### 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::EventsApi.new
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example', # String | 
+  school: 'school_example', # String | 
+  record_type: ['record_type_example'] # Array<String> | 
+}
+
+begin
+  result = api_instance.get_events(opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+ **school** | **String**|  | [optional] 
+ **record_type** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/EventsResponse.md

@@ -0,0 +1,9 @@
+# Clever::EventsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<EventResponse>**](EventResponse.md) |  | [optional] 
+**links** | [**Array<Link>**](Link.md) |  | [optional] 
+
+

data/docs/InternalError.md

@@ -0,0 +1,8 @@
+# Clever::InternalError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+
+

data/docs/Link.md

@@ -0,0 +1,9 @@
+# Clever::Link
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**uri** | **String** |  | [optional] 
+
+

data/docs/Location.md

@@ -0,0 +1,13 @@
+# Clever::Location
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**lat** | **String** |  | [optional] 
+**lon** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**zip** | **String** |  | [optional] 
+
+

data/docs/Name.md

@@ -0,0 +1,10 @@
+# Clever::Name
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | **String** |  | [optional] 
+**last** | **String** |  | [optional] 
+**middle** | **String** |  | [optional] 
+
+

data/docs/NotFound.md

@@ -0,0 +1,8 @@
+# Clever::NotFound
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+
+

data/docs/Principal.md

@@ -0,0 +1,9 @@
+# Clever::Principal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/School.md

@@ -0,0 +1,23 @@
+# Clever::School
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**principal** | [**Principal**](Principal.md) |  | [optional] 
+**school_number** | **String** |  | [optional] 
+**sis_id** | **String** |  | [optional] 
+**state_id** | **String** |  | [optional] 
+
+

data/docs/SchoolAdmin.md

@@ -0,0 +1,17 @@
+# Clever::SchoolAdmin
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+

data/docs/SchoolAdminObject.md

@@ -0,0 +1,8 @@
+# Clever::SchoolAdminObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**SchoolAdmin**](SchoolAdmin.md) |  | [optional] 
+
+