commonlit-clever-ruby 2.1.4 → 2.1.6.beta2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +46 -41
  4. data/Makefile +1 -1
  5. data/README.md +943 -11
  6. data/clever-ruby.gemspec +3 -10
  7. data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
  8. data/docs/AdminName.md +0 -1
  9. data/docs/BadRequest.md +0 -1
  10. data/docs/Contact.md +0 -1
  11. data/docs/ContactObject.md +0 -1
  12. data/docs/ContactResponse.md +0 -1
  13. data/docs/ContactsCreated.md +0 -1
  14. data/docs/ContactsDeleted.md +0 -1
  15. data/docs/ContactsResponse.md +0 -1
  16. data/docs/ContactsUpdated.md +0 -1
  17. data/docs/Course.md +0 -1
  18. data/docs/CourseObject.md +0 -1
  19. data/docs/CourseResponse.md +0 -1
  20. data/docs/CoursesCreated.md +0 -1
  21. data/docs/CoursesDeleted.md +0 -1
  22. data/docs/CoursesResponse.md +0 -1
  23. data/docs/CoursesUpdated.md +0 -1
  24. data/docs/Credentials.md +0 -1
  25. data/docs/DataApi.md +1 -69
  26. data/docs/District.md +0 -1
  27. data/docs/DistrictAdmin.md +0 -1
  28. data/docs/DistrictAdminObject.md +0 -1
  29. data/docs/DistrictAdminResponse.md +0 -1
  30. data/docs/DistrictAdminsResponse.md +0 -1
  31. data/docs/DistrictObject.md +0 -1
  32. data/docs/DistrictResponse.md +0 -1
  33. data/docs/DistrictadminsCreated.md +0 -1
  34. data/docs/DistrictadminsDeleted.md +0 -1
  35. data/docs/DistrictadminsUpdated.md +0 -1
  36. data/docs/DistrictsCreated.md +0 -1
  37. data/docs/DistrictsDeleted.md +0 -1
  38. data/docs/DistrictsResponse.md +0 -1
  39. data/docs/DistrictsUpdated.md +0 -1
  40. data/docs/Event.md +0 -1
  41. data/docs/EventResponse.md +0 -1
  42. data/docs/EventsApi.md +0 -3
  43. data/docs/EventsResponse.md +0 -1
  44. data/docs/InternalError.md +0 -1
  45. data/docs/Link.md +0 -1
  46. data/docs/Location.md +0 -1
  47. data/docs/Name.md +0 -1
  48. data/docs/NotFound.md +0 -1
  49. data/docs/Principal.md +0 -1
  50. data/docs/School.md +0 -1
  51. data/docs/SchoolAdmin.md +0 -1
  52. data/docs/SchoolAdminObject.md +0 -1
  53. data/docs/SchoolAdminResponse.md +0 -1
  54. data/docs/SchoolAdminsResponse.md +0 -1
  55. data/docs/SchoolEnrollment.md +0 -1
  56. data/docs/SchoolObject.md +0 -1
  57. data/docs/SchoolResponse.md +0 -1
  58. data/docs/SchooladminsCreated.md +0 -1
  59. data/docs/SchooladminsDeleted.md +0 -1
  60. data/docs/SchooladminsUpdated.md +0 -1
  61. data/docs/SchoolsCreated.md +0 -1
  62. data/docs/SchoolsDeleted.md +0 -1
  63. data/docs/SchoolsResponse.md +0 -1
  64. data/docs/SchoolsUpdated.md +0 -1
  65. data/docs/Section.md +0 -1
  66. data/docs/SectionObject.md +0 -1
  67. data/docs/SectionResponse.md +0 -1
  68. data/docs/SectionsCreated.md +0 -1
  69. data/docs/SectionsDeleted.md +0 -1
  70. data/docs/SectionsResponse.md +0 -1
  71. data/docs/SectionsUpdated.md +0 -1
  72. data/docs/Student.md +0 -1
  73. data/docs/StudentObject.md +0 -1
  74. data/docs/StudentResponse.md +0 -1
  75. data/docs/StudentsCreated.md +0 -1
  76. data/docs/StudentsDeleted.md +0 -1
  77. data/docs/StudentsResponse.md +0 -1
  78. data/docs/StudentsUpdated.md +0 -1
  79. data/docs/Teacher.md +0 -1
  80. data/docs/TeacherObject.md +0 -1
  81. data/docs/TeacherResponse.md +0 -1
  82. data/docs/TeachersCreated.md +0 -1
  83. data/docs/TeachersDeleted.md +0 -1
  84. data/docs/TeachersResponse.md +0 -1
  85. data/docs/TeachersUpdated.md +0 -1
  86. data/docs/Term.md +0 -1
  87. data/docs/TermObject.md +0 -1
  88. data/docs/TermResponse.md +0 -1
  89. data/docs/TermsCreated.md +0 -1
  90. data/docs/TermsDeleted.md +0 -1
  91. data/docs/TermsResponse.md +0 -1
  92. data/docs/TermsUpdated.md +0 -1
  93. data/full-v2.yml +2541 -0
  94. data/lib/clever-ruby/api/data_api.rb +836 -635
  95. data/lib/clever-ruby/api/events_api.rb +23 -18
  96. data/lib/clever-ruby/api_client.rb +1 -0
  97. data/lib/clever-ruby/api_error.rb +21 -2
  98. data/lib/clever-ruby/configuration.rb +3 -7
  99. data/lib/clever-ruby/models/admin_name.rb +44 -20
  100. data/lib/clever-ruby/models/bad_request.rb +40 -18
  101. data/lib/clever-ruby/models/contact.rb +73 -45
  102. data/lib/clever-ruby/models/contact_object.rb +40 -18
  103. data/lib/clever-ruby/models/contact_response.rb +40 -18
  104. data/lib/clever-ruby/models/contacts_response.rb +42 -20
  105. data/lib/clever-ruby/models/course.rb +48 -24
  106. data/lib/clever-ruby/models/course_object.rb +40 -18
  107. data/lib/clever-ruby/models/course_response.rb +40 -18
  108. data/lib/clever-ruby/models/courses_response.rb +42 -20
  109. data/lib/clever-ruby/models/credentials.rb +40 -18
  110. data/lib/clever-ruby/models/district.rb +75 -47
  111. data/lib/clever-ruby/models/district_admin.rb +49 -26
  112. data/lib/clever-ruby/models/district_admin_object.rb +40 -18
  113. data/lib/clever-ruby/models/district_admin_response.rb +40 -18
  114. data/lib/clever-ruby/models/district_admins_response.rb +42 -20
  115. data/lib/clever-ruby/models/district_object.rb +40 -18
  116. data/lib/clever-ruby/models/district_response.rb +40 -18
  117. data/lib/clever-ruby/models/districts_response.rb +42 -20
  118. data/lib/clever-ruby/models/event.rb +49 -22
  119. data/lib/clever-ruby/models/event_response.rb +40 -18
  120. data/lib/clever-ruby/models/events_response.rb +42 -20
  121. data/lib/clever-ruby/models/internal_error.rb +40 -18
  122. data/lib/clever-ruby/models/link.rb +45 -23
  123. data/lib/clever-ruby/models/location.rb +56 -28
  124. data/lib/clever-ruby/models/name.rb +47 -22
  125. data/lib/clever-ruby/models/not_found.rb +40 -18
  126. data/lib/clever-ruby/models/principal.rb +44 -20
  127. data/lib/clever-ruby/models/school.rb +81 -53
  128. data/lib/clever-ruby/models/school_admin.rb +59 -35
  129. data/lib/clever-ruby/models/school_admin_object.rb +40 -18
  130. data/lib/clever-ruby/models/school_admin_response.rb +40 -18
  131. data/lib/clever-ruby/models/school_admins_response.rb +42 -20
  132. data/lib/clever-ruby/models/school_enrollment.rb +44 -22
  133. data/lib/clever-ruby/models/school_object.rb +40 -18
  134. data/lib/clever-ruby/models/school_response.rb +40 -18
  135. data/lib/clever-ruby/models/schools_response.rb +42 -20
  136. data/lib/clever-ruby/models/section.rb +84 -55
  137. data/lib/clever-ruby/models/section_object.rb +40 -18
  138. data/lib/clever-ruby/models/section_response.rb +40 -18
  139. data/lib/clever-ruby/models/sections_response.rb +42 -20
  140. data/lib/clever-ruby/models/student.rb +121 -100
  141. data/lib/clever-ruby/models/student_object.rb +40 -18
  142. data/lib/clever-ruby/models/student_response.rb +40 -18
  143. data/lib/clever-ruby/models/students_response.rb +42 -20
  144. data/lib/clever-ruby/models/teacher.rb +69 -43
  145. data/lib/clever-ruby/models/teacher_object.rb +40 -18
  146. data/lib/clever-ruby/models/teacher_response.rb +40 -18
  147. data/lib/clever-ruby/models/teachers_response.rb +42 -20
  148. data/lib/clever-ruby/models/term.rb +51 -26
  149. data/lib/clever-ruby/models/term_object.rb +40 -18
  150. data/lib/clever-ruby/models/term_response.rb +40 -18
  151. data/lib/clever-ruby/models/terms_response.rb +42 -20
  152. data/lib/clever-ruby/version.rb +2 -3
  153. data/lib/clever-ruby.rb +1 -2
  154. data/override/README-extension.md +4 -5
  155. data/override/api_client.rb +1 -0
  156. data/override/override.sh +7 -5
  157. data/spec/api/data_api_spec.rb +671 -0
  158. data/spec/api/events_api_spec.rb +61 -0
  159. data/spec/api_client_spec.rb +243 -0
  160. data/spec/spec_helper.rb +26 -18
  161. metadata +34 -150
  162. data/commonlit-clever-ruby-2.1.3.gem +0 -0
  163. data/spec/events.json +0 -227
  164. data/tags +0 -1681
data/docs/EventsApi.md CHANGED
@@ -7,7 +7,6 @@ Method | HTTP request | Description
7
7
  [**get_event**](EventsApi.md#get_event) | **GET** /events/{id} |
8
8
  [**get_events**](EventsApi.md#get_events) | **GET** /events |
9
9
 
10
-
11
10
  # **get_event**
12
11
  > EventResponse get_event(id)
13
12
 
@@ -26,7 +25,6 @@ Clever.configure do |config|
26
25
  end
27
26
 
28
27
  api_instance = Clever::EventsApi.new
29
-
30
28
  id = 'id_example' # String |
31
29
 
32
30
 
@@ -77,7 +75,6 @@ Clever.configure do |config|
77
75
  end
78
76
 
79
77
  api_instance = Clever::EventsApi.new
80
-
81
78
  opts = {
82
79
  limit: 56, # Integer |
83
80
  starting_after: 'starting_after_example', # String |
data/docs/EventsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<EventResponse>**](EventResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/InternalError.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **message** | **String** | | [optional]
7
7
 
8
-
data/docs/Link.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **rel** | **String** | | [optional]
7
7
  **uri** | **String** | | [optional]
8
8
 
9
-
data/docs/Location.md CHANGED
@@ -10,4 +10,3 @@ Name | Type | Description | Notes
10
10
  **state** | **String** | | [optional]
11
11
  **zip** | **String** | | [optional]
12
12
 
13
-
data/docs/Name.md CHANGED
@@ -7,4 +7,3 @@ Name | Type | Description | Notes
7
7
  **last** | **String** | | [optional]
8
8
  **middle** | **String** | | [optional]
9
9
 
10
-
data/docs/NotFound.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **message** | **String** | | [optional]
7
7
 
8
-
data/docs/Principal.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **email** | **String** | | [optional]
7
7
  **name** | **String** | | [optional]
8
8
 
9
-
data/docs/School.md CHANGED
@@ -20,4 +20,3 @@ Name | Type | Description | Notes
20
20
  **sis_id** | **String** | | [optional]
21
21
  **state_id** | **String** | | [optional]
22
22
 
23
-
data/docs/SchoolAdmin.md CHANGED
@@ -14,4 +14,3 @@ Name | Type | Description | Notes
14
14
  **staff_id** | **String** | | [optional]
15
15
  **title** | **String** | | [optional]
16
16
 
17
-
data/docs/SchoolAdminObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**SchoolAdmin**](SchoolAdmin.md) | | [optional]
7
7
 
8
-
data/docs/SchoolAdminResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**SchoolAdmin**](SchoolAdmin.md) | | [optional]
7
7
 
8
-
data/docs/SchoolAdminsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<SchoolAdminResponse>**](SchoolAdminResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/SchoolEnrollment.md CHANGED
@@ -7,4 +7,3 @@ Name | Type | Description | Notes
7
7
  **school** | **String** | | [optional]
8
8
  **start_date** | **String** | | [optional]
9
9
 
10
-
data/docs/SchoolObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**School**](School.md) | | [optional]
7
7
 
8
-
data/docs/SchoolResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**School**](School.md) | | [optional]
7
7
 
8
-
data/docs/SchooladminsCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
10
10
 
11
-
data/docs/SchooladminsDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
10
10
 
11
-
data/docs/SchooladminsUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-
data/docs/SchoolsCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
10
10
 
11
-
data/docs/SchoolsDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
10
10
 
11
-
data/docs/SchoolsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<SchoolResponse>**](SchoolResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/SchoolsUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-
data/docs/Section.md CHANGED
@@ -21,4 +21,3 @@ Name | Type | Description | Notes
21
21
  **teachers** | **Array<String>** | | [optional]
22
22
  **term_id** | **String** | | [optional]
23
23
 
24
-
data/docs/SectionObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**Section**](Section.md) | | [optional]
7
7
 
8
-
data/docs/SectionResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**Section**](Section.md) | | [optional]
7
7
 
8
-
data/docs/SectionsCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
10
10
 
11
-
data/docs/SectionsDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
10
10
 
11
-
data/docs/SectionsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<SectionResponse>**](SectionResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/SectionsUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-
data/docs/Student.md CHANGED
@@ -30,4 +30,3 @@ Name | Type | Description | Notes
30
30
  **unweighted_gpa** | **String** | | [optional]
31
31
  **weighted_gpa** | **String** | | [optional]
32
32
 
33
-
data/docs/StudentObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**Student**](Student.md) | | [optional]
7
7
 
8
-
data/docs/StudentResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**Student**](Student.md) | | [optional]
7
7
 
8
-
data/docs/StudentsCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**StudentObject**](StudentObject.md) | | [optional]
10
10
 
11
-
data/docs/StudentsDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**StudentObject**](StudentObject.md) | | [optional]
10
10
 
11
-
data/docs/StudentsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<StudentResponse>**](StudentResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/StudentsUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**StudentObject**](StudentObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-
data/docs/Teacher.md CHANGED
@@ -18,4 +18,3 @@ Name | Type | Description | Notes
18
18
  **teacher_number** | **String** | | [optional]
19
19
  **title** | **String** | | [optional]
20
20
 
21
-
data/docs/TeacherObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**Teacher**](Teacher.md) | | [optional]
7
7
 
8
-
data/docs/TeacherResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**Teacher**](Teacher.md) | | [optional]
7
7
 
8
-
data/docs/TeachersCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**TeacherObject**](TeacherObject.md) | | [optional]
10
10
 
11
-
data/docs/TeachersDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**TeacherObject**](TeacherObject.md) | | [optional]
10
10
 
11
-
data/docs/TeachersResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<TeacherResponse>**](TeacherResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/TeachersUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**TeacherObject**](TeacherObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-
data/docs/Term.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **name** | **String** | | [optional]
10
10
  **start_date** | **String** | | [optional]
11
11
 
12
-
data/docs/TermObject.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **object** | [**Term**](Term.md) | | [optional]
7
7
 
8
-
data/docs/TermResponse.md CHANGED
@@ -5,4 +5,3 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **data** | [**Term**](Term.md) | | [optional]
7
7
 
8
-
data/docs/TermsCreated.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**TermObject**](TermObject.md) | | [optional]
10
10
 
11
-
data/docs/TermsDeleted.md CHANGED
@@ -8,4 +8,3 @@ Name | Type | Description | Notes
8
8
  **type** | **String** | |
9
9
  **data** | [**TermObject**](TermObject.md) | | [optional]
10
10
 
11
-
data/docs/TermsResponse.md CHANGED
@@ -6,4 +6,3 @@ Name | Type | Description | Notes
6
6
  **data** | [**Array<TermResponse>**](TermResponse.md) | | [optional]
7
7
  **links** | [**Array<Link>**](Link.md) | | [optional]
8
8
 
9
-
data/docs/TermsUpdated.md CHANGED
@@ -9,4 +9,3 @@ Name | Type | Description | Notes
9
9
  **data** | [**TermObject**](TermObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
12
-