clever-ruby 0.14.0 → 1.0.0

data/docs/District.md

@@ -0,0 +1,10 @@
+# Clever::District
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**mdr_number** | **String** |  | [optional] 
+
+

data/docs/DistrictAdmin.md

@@ -0,0 +1,12 @@
+# Clever::DistrictAdmin
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | [**Name**](Name.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**district** | **String** |  | [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,8 @@
+# Clever::DistrictAdminsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DistrictAdmin>**](DistrictAdmin.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/DistrictStatus.md

@@ -0,0 +1,15 @@
+# Clever::DistrictStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **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_state** | **String** |  | [optional] 
+
+

data/docs/DistrictStatusResponse.md

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

data/docs/DistrictsCreated.md

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

data/docs/DistrictsDeleted.md

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

data/docs/DistrictsResponse.md

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

data/docs/DistrictsUpdated.md

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

data/docs/Event.md

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

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,424 @@
+# Clever::EventsApi
+
+All URIs are relative to *https://api.clever.com/v1.2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_event**](EventsApi.md#get_event) | **GET** /events/{id} | Retrieves a single event.
+[**get_events**](EventsApi.md#get_events) | **GET** /events | Retrieves all events
+[**get_events_for_school**](EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events | Retrieves events for schools.
+[**get_events_for_school_admin**](EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events | Retrieves events for school_admins.
+[**get_events_for_section**](EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events | Retrieves events for sections.
+[**get_events_for_student**](EventsApi.md#get_events_for_student) | **GET** /students/{id}/events | Retrieves events for students.
+[**get_events_for_teacher**](EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events | Retrieves events for teachers.
+
+
+# **get_event**
+> EventResponse get_event(id)
+
+Retrieves a single event.
+
+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
+  #Retrieves a single event.
+  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)
+
+Retrieves all events
+
+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 | 
+}
+
+begin
+  #Retrieves all events
+  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] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events_for_school**
+> EventsResponse get_events_for_school(id, opts)
+
+Retrieves events for schools.
+
+Returns a list of events 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::EventsApi.new
+
+id = "id_example" # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: "starting_after_example", # String | 
+  ending_before: "ending_before_example" # String | 
+}
+
+begin
+  #Retrieves events for schools.
+  result = api_instance.get_events_for_school(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events_for_school: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events_for_school_admin**
+> EventsResponse get_events_for_school_admin(id, opts)
+
+Retrieves events for school_admins.
+
+Returns a list of events 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::EventsApi.new
+
+id = "id_example" # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: "starting_after_example", # String | 
+  ending_before: "ending_before_example" # String | 
+}
+
+begin
+  #Retrieves events for school_admins.
+  result = api_instance.get_events_for_school_admin(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events_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
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events_for_section**
+> EventsResponse get_events_for_section(id, opts)
+
+Retrieves events for sections.
+
+Returns a list of events for a section
+
+### 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 | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: "starting_after_example", # String | 
+  ending_before: "ending_before_example" # String | 
+}
+
+begin
+  #Retrieves events for sections.
+  result = api_instance.get_events_for_section(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events_for_section: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events_for_student**
+> EventsResponse get_events_for_student(id, opts)
+
+Retrieves events for students.
+
+Returns a list of events for a student
+
+### 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 | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: "starting_after_example", # String | 
+  ending_before: "ending_before_example" # String | 
+}
+
+begin
+  #Retrieves events for students.
+  result = api_instance.get_events_for_student(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events_for_student: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_events_for_teacher**
+> EventsResponse get_events_for_teacher(id, opts)
+
+Retrieves events for teachers.
+
+Returns a list of events 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::EventsApi.new
+
+id = "id_example" # String | 
+
+opts = { 
+  limit: 56, # Integer | 
+  starting_after: "starting_after_example", # String | 
+  ending_before: "ending_before_example" # String | 
+}
+
+begin
+  #Retrieves events for teachers.
+  result = api_instance.get_events_for_teacher(id, opts)
+  p result
+rescue Clever::ApiError => e
+  puts "Exception when calling EventsApi->get_events_for_teacher: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **limit** | **Integer**|  | [optional] 
+ **starting_after** | **String**|  | [optional] 
+ **ending_before** | **String**|  | [optional] 
+
+### Return type
+
+[**EventsResponse**](EventsResponse.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+