RubyGems - commonlit-clever-ruby - Versions diffs - 2.1.6.beta1 → 2.1.6.beta2 - Mend

commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta2

Files changed (188) hide show

checksums.yaml +4 -4
data/Gemfile +3 -1
data/Gemfile.lock +37 -29
data/README.md +994 -61
data/clever-ruby.gemspec +6 -13
data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
data/docs/AdminName.md +0 -1
data/docs/BadRequest.md +0 -1
data/docs/Contact.md +1 -2
data/docs/ContactObject.md +0 -1
data/docs/ContactResponse.md +0 -1
data/docs/ContactsCreated.md +2 -3
data/docs/ContactsDeleted.md +2 -3
data/docs/ContactsResponse.md +0 -1
data/docs/ContactsUpdated.md +2 -3
data/docs/Course.md +1 -2
data/docs/CourseObject.md +0 -1
data/docs/CourseResponse.md +0 -1
data/docs/CoursesCreated.md +2 -3
data/docs/CoursesDeleted.md +2 -3
data/docs/CoursesResponse.md +0 -1
data/docs/CoursesUpdated.md +2 -3
data/docs/Credentials.md +0 -1
data/docs/DataApi.md +2784 -0
data/docs/District.md +9 -10
data/docs/DistrictAdmin.md +2 -3
data/docs/DistrictAdminObject.md +0 -1
data/docs/DistrictAdminResponse.md +0 -1
data/docs/DistrictAdminsResponse.md +0 -1
data/docs/DistrictObject.md +0 -1
data/docs/DistrictResponse.md +0 -1
data/docs/DistrictadminsCreated.md +2 -3
data/docs/DistrictadminsDeleted.md +2 -3
data/docs/DistrictadminsUpdated.md +2 -3
data/docs/DistrictsCreated.md +2 -3
data/docs/DistrictsDeleted.md +2 -3
data/docs/DistrictsResponse.md +0 -1
data/docs/DistrictsUpdated.md +2 -3
data/docs/Event.md +2 -3
data/docs/EventResponse.md +0 -1
data/docs/EventsApi.md +1 -4
data/docs/EventsResponse.md +0 -1
data/docs/InternalError.md +0 -1
data/docs/Link.md +0 -1
data/docs/Location.md +2 -3
data/docs/Name.md +1 -2
data/docs/NotFound.md +0 -1
data/docs/Principal.md +1 -2
data/docs/School.md +3 -4
data/docs/SchoolAdmin.md +3 -4
data/docs/SchoolAdminObject.md +0 -1
data/docs/SchoolAdminResponse.md +0 -1
data/docs/SchoolAdminsResponse.md +0 -1
data/docs/SchoolEnrollment.md +1 -2
data/docs/SchoolObject.md +0 -1
data/docs/SchoolResponse.md +0 -1
data/docs/SchooladminsCreated.md +2 -3
data/docs/SchooladminsDeleted.md +2 -3
data/docs/SchooladminsUpdated.md +2 -3
data/docs/SchoolsCreated.md +2 -3
data/docs/SchoolsDeleted.md +2 -3
data/docs/SchoolsResponse.md +0 -1
data/docs/SchoolsUpdated.md +2 -3
data/docs/Section.md +2 -3
data/docs/SectionObject.md +0 -1
data/docs/SectionResponse.md +0 -1
data/docs/SectionsCreated.md +2 -3
data/docs/SectionsDeleted.md +2 -3
data/docs/SectionsResponse.md +0 -1
data/docs/SectionsUpdated.md +2 -3
data/docs/Student.md +3 -4
data/docs/StudentObject.md +0 -1
data/docs/StudentResponse.md +0 -1
data/docs/StudentsCreated.md +2 -3
data/docs/StudentsDeleted.md +2 -3
data/docs/StudentsResponse.md +0 -1
data/docs/StudentsUpdated.md +2 -3
data/docs/Teacher.md +2 -3
data/docs/TeacherObject.md +0 -1
data/docs/TeacherResponse.md +0 -1
data/docs/TeachersCreated.md +2 -3
data/docs/TeachersDeleted.md +2 -3
data/docs/TeachersResponse.md +0 -1
data/docs/TeachersUpdated.md +2 -3
data/docs/Term.md +2 -3
data/docs/TermObject.md +0 -1
data/docs/TermResponse.md +0 -1
data/docs/TermsCreated.md +2 -3
data/docs/TermsDeleted.md +2 -3
data/docs/TermsResponse.md +0 -1
data/docs/TermsUpdated.md +2 -3
data/git_push.sh +55 -0
data/lib/clever-ruby/api/data_api.rb +2999 -0
data/lib/clever-ruby/api/events_api.rb +25 -20
data/lib/clever-ruby/api_error.rb +23 -4
data/lib/clever-ruby/configuration.rb +5 -9
data/lib/clever-ruby/models/admin_name.rb +46 -22
data/lib/clever-ruby/models/bad_request.rb +42 -20
data/lib/clever-ruby/models/contact.rb +83 -55
data/lib/clever-ruby/models/contact_object.rb +42 -20
data/lib/clever-ruby/models/contact_response.rb +42 -20
data/lib/clever-ruby/models/contacts_response.rb +44 -22
data/lib/clever-ruby/models/course.rb +60 -36
data/lib/clever-ruby/models/course_object.rb +42 -20
data/lib/clever-ruby/models/course_response.rb +42 -20
data/lib/clever-ruby/models/courses_response.rb +44 -22
data/lib/clever-ruby/models/credentials.rb +42 -20
data/lib/clever-ruby/models/district.rb +122 -94
data/lib/clever-ruby/models/district_admin.rb +67 -44
data/lib/clever-ruby/models/district_admin_object.rb +42 -20
data/lib/clever-ruby/models/district_admin_response.rb +42 -20
data/lib/clever-ruby/models/district_admins_response.rb +44 -22
data/lib/clever-ruby/models/district_object.rb +42 -20
data/lib/clever-ruby/models/district_response.rb +42 -20
data/lib/clever-ruby/models/districts_response.rb +44 -22
data/lib/clever-ruby/models/event.rb +60 -33
data/lib/clever-ruby/models/event_response.rb +42 -20
data/lib/clever-ruby/models/events_response.rb +44 -22
data/lib/clever-ruby/models/internal_error.rb +42 -20
data/lib/clever-ruby/models/link.rb +47 -25
data/lib/clever-ruby/models/location.rb +73 -45
data/lib/clever-ruby/models/name.rb +58 -33
data/lib/clever-ruby/models/not_found.rb +42 -20
data/lib/clever-ruby/models/principal.rb +55 -31
data/lib/clever-ruby/models/school.rb +108 -80
data/lib/clever-ruby/models/school_admin.rb +85 -61
data/lib/clever-ruby/models/school_admin_object.rb +42 -20
data/lib/clever-ruby/models/school_admin_response.rb +42 -20
data/lib/clever-ruby/models/school_admins_response.rb +44 -22
data/lib/clever-ruby/models/school_enrollment.rb +56 -34
data/lib/clever-ruby/models/school_object.rb +42 -20
data/lib/clever-ruby/models/school_response.rb +42 -20
data/lib/clever-ruby/models/schools_response.rb +44 -22
data/lib/clever-ruby/models/section.rb +104 -75
data/lib/clever-ruby/models/section_object.rb +42 -20
data/lib/clever-ruby/models/section_response.rb +42 -20
data/lib/clever-ruby/models/sections_response.rb +44 -22
data/lib/clever-ruby/models/student.rb +147 -126
data/lib/clever-ruby/models/student_object.rb +42 -20
data/lib/clever-ruby/models/student_response.rb +42 -20
data/lib/clever-ruby/models/students_response.rb +44 -22
data/lib/clever-ruby/models/teacher.rb +89 -63
data/lib/clever-ruby/models/teacher_object.rb +42 -20
data/lib/clever-ruby/models/teacher_response.rb +42 -20
data/lib/clever-ruby/models/teachers_response.rb +44 -22
data/lib/clever-ruby/models/term.rb +69 -44
data/lib/clever-ruby/models/term_object.rb +42 -20
data/lib/clever-ruby/models/term_response.rb +42 -20
data/lib/clever-ruby/models/terms_response.rb +44 -22
data/lib/clever-ruby/version.rb +4 -5
data/lib/clever-ruby.rb +4 -14
data/override/README-extension.md +1 -1
data/override/override.sh +3 -0
data/spec/api/data_api_spec.rb +671 -0
data/spec/api/events_api_spec.rb +4 -3
data/spec/api_client_spec.rb +21 -3
data/spec/spec_helper.rb +4 -3
metadata +25 -179
data/docs/ContactsApi.md +0 -231
data/docs/CoursesApi.md +0 -231
data/docs/DistrictAdminsApi.md +0 -171
data/docs/DistrictsApi.md +0 -113
data/docs/SchoolAdminsApi.md +0 -231
data/docs/SchoolsApi.md +0 -351
data/docs/SectionsApi.md +0 -499
data/docs/StudentsApi.md +0 -463
data/docs/TeachersApi.md +0 -403
data/docs/TermsApi.md +0 -231
data/lib/clever-ruby/api/contacts_api.rb +0 -241
data/lib/clever-ruby/api/courses_api.rb +0 -241
data/lib/clever-ruby/api/district_admins_api.rb +0 -182
data/lib/clever-ruby/api/districts_api.rb +0 -123
data/lib/clever-ruby/api/school_admins_api.rb +0 -241
data/lib/clever-ruby/api/schools_api.rb +0 -359
data/lib/clever-ruby/api/sections_api.rb +0 -500
data/lib/clever-ruby/api/students_api.rb +0 -468
data/lib/clever-ruby/api/teachers_api.rb +0 -409
data/lib/clever-ruby/api/terms_api.rb +0 -241
data/spec/api/contacts_api_spec.rb +0 -84
data/spec/api/courses_api_spec.rb +0 -84
data/spec/api/district_admins_api_spec.rb +0 -70
data/spec/api/districts_api_spec.rb +0 -56
data/spec/api/school_admins_api_spec.rb +0 -84
data/spec/api/schools_api_spec.rb +0 -112
data/spec/api/sections_api_spec.rb +0 -142
data/spec/api/students_api_spec.rb +0 -137
data/spec/api/teachers_api_spec.rb +0 -123
data/spec/api/terms_api_spec.rb +0 -84

data/docs/SchoolAdminsApi.md DELETED Viewed

@@ -1,231 +0,0 @@
-# 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/SchoolsApi.md DELETED Viewed

@@ -1,351 +0,0 @@
-# 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