commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +27 -30
  3. data/Makefile +1 -1
  4. data/README.md +60 -61
  5. data/clever-ruby.gemspec +6 -6
  6. data/docs/Contact.md +1 -1
  7. data/docs/ContactsApi.md +231 -0
  8. data/docs/ContactsCreated.md +2 -2
  9. data/docs/ContactsDeleted.md +2 -2
  10. data/docs/ContactsUpdated.md +2 -2
  11. data/docs/Course.md +1 -1
  12. data/docs/CoursesApi.md +231 -0
  13. data/docs/CoursesCreated.md +2 -2
  14. data/docs/CoursesDeleted.md +2 -2
  15. data/docs/CoursesUpdated.md +2 -2
  16. data/docs/District.md +9 -9
  17. data/docs/DistrictAdmin.md +2 -2
  18. data/docs/DistrictAdminsApi.md +171 -0
  19. data/docs/DistrictadminsCreated.md +2 -2
  20. data/docs/DistrictadminsDeleted.md +2 -2
  21. data/docs/DistrictadminsUpdated.md +2 -2
  22. data/docs/DistrictsApi.md +113 -0
  23. data/docs/DistrictsCreated.md +2 -2
  24. data/docs/DistrictsDeleted.md +2 -2
  25. data/docs/DistrictsUpdated.md +2 -2
  26. data/docs/Event.md +2 -2
  27. data/docs/EventsApi.md +1 -1
  28. data/docs/Location.md +2 -2
  29. data/docs/Name.md +1 -1
  30. data/docs/Principal.md +1 -1
  31. data/docs/School.md +3 -3
  32. data/docs/SchoolAdmin.md +3 -3
  33. data/docs/SchoolAdminsApi.md +231 -0
  34. data/docs/SchoolEnrollment.md +1 -1
  35. data/docs/SchooladminsCreated.md +2 -2
  36. data/docs/SchooladminsDeleted.md +2 -2
  37. data/docs/SchooladminsUpdated.md +2 -2
  38. data/docs/SchoolsApi.md +351 -0
  39. data/docs/SchoolsCreated.md +2 -2
  40. data/docs/SchoolsDeleted.md +2 -2
  41. data/docs/SchoolsUpdated.md +2 -2
  42. data/docs/Section.md +2 -2
  43. data/docs/SectionsApi.md +499 -0
  44. data/docs/SectionsCreated.md +2 -2
  45. data/docs/SectionsDeleted.md +2 -2
  46. data/docs/SectionsUpdated.md +2 -2
  47. data/docs/Student.md +3 -3
  48. data/docs/StudentsApi.md +463 -0
  49. data/docs/StudentsCreated.md +2 -2
  50. data/docs/StudentsDeleted.md +2 -2
  51. data/docs/StudentsUpdated.md +2 -2
  52. data/docs/Teacher.md +2 -2
  53. data/docs/TeachersApi.md +403 -0
  54. data/docs/TeachersCreated.md +2 -2
  55. data/docs/TeachersDeleted.md +2 -2
  56. data/docs/TeachersUpdated.md +2 -2
  57. data/docs/Term.md +2 -2
  58. data/docs/TermsApi.md +231 -0
  59. data/docs/TermsCreated.md +2 -2
  60. data/docs/TermsDeleted.md +2 -2
  61. data/docs/TermsUpdated.md +2 -2
  62. data/full-v2.yml +2541 -0
  63. data/lib/clever-ruby/api/contacts_api.rb +241 -0
  64. data/lib/clever-ruby/api/courses_api.rb +241 -0
  65. data/lib/clever-ruby/api/district_admins_api.rb +182 -0
  66. data/lib/clever-ruby/api/districts_api.rb +123 -0
  67. data/lib/clever-ruby/api/events_api.rb +3 -3
  68. data/lib/clever-ruby/api/school_admins_api.rb +241 -0
  69. data/lib/clever-ruby/api/schools_api.rb +359 -0
  70. data/lib/clever-ruby/api/sections_api.rb +500 -0
  71. data/lib/clever-ruby/api/students_api.rb +468 -0
  72. data/lib/clever-ruby/api/teachers_api.rb +409 -0
  73. data/lib/clever-ruby/api/terms_api.rb +241 -0
  74. data/lib/clever-ruby/api_client.rb +1 -0
  75. data/lib/clever-ruby/api_error.rb +3 -3
  76. data/lib/clever-ruby/configuration.rb +4 -4
  77. data/lib/clever-ruby/models/admin_name.rb +3 -3
  78. data/lib/clever-ruby/models/bad_request.rb +3 -3
  79. data/lib/clever-ruby/models/contact.rb +13 -13
  80. data/lib/clever-ruby/models/contact_object.rb +3 -3
  81. data/lib/clever-ruby/models/contact_response.rb +3 -3
  82. data/lib/clever-ruby/models/contacts_response.rb +3 -3
  83. data/lib/clever-ruby/models/course.rb +16 -16
  84. data/lib/clever-ruby/models/course_object.rb +3 -3
  85. data/lib/clever-ruby/models/course_response.rb +3 -3
  86. data/lib/clever-ruby/models/courses_response.rb +3 -3
  87. data/lib/clever-ruby/models/credentials.rb +3 -3
  88. data/lib/clever-ruby/models/district.rb +69 -69
  89. data/lib/clever-ruby/models/district_admin.rb +25 -25
  90. data/lib/clever-ruby/models/district_admin_object.rb +3 -3
  91. data/lib/clever-ruby/models/district_admin_response.rb +3 -3
  92. data/lib/clever-ruby/models/district_admins_response.rb +3 -3
  93. data/lib/clever-ruby/models/district_object.rb +3 -3
  94. data/lib/clever-ruby/models/district_response.rb +3 -3
  95. data/lib/clever-ruby/models/districts_response.rb +3 -3
  96. data/lib/clever-ruby/models/event.rb +16 -16
  97. data/lib/clever-ruby/models/event_response.rb +3 -3
  98. data/lib/clever-ruby/models/events_response.rb +3 -3
  99. data/lib/clever-ruby/models/internal_error.rb +3 -3
  100. data/lib/clever-ruby/models/link.rb +3 -3
  101. data/lib/clever-ruby/models/location.rb +25 -25
  102. data/lib/clever-ruby/models/name.rb +16 -16
  103. data/lib/clever-ruby/models/not_found.rb +3 -3
  104. data/lib/clever-ruby/models/principal.rb +16 -16
  105. data/lib/clever-ruby/models/school.rb +34 -34
  106. data/lib/clever-ruby/models/school_admin.rb +34 -34
  107. data/lib/clever-ruby/models/school_admin_object.rb +3 -3
  108. data/lib/clever-ruby/models/school_admin_response.rb +3 -3
  109. data/lib/clever-ruby/models/school_admins_response.rb +3 -3
  110. data/lib/clever-ruby/models/school_enrollment.rb +16 -16
  111. data/lib/clever-ruby/models/school_object.rb +3 -3
  112. data/lib/clever-ruby/models/school_response.rb +3 -3
  113. data/lib/clever-ruby/models/schools_response.rb +3 -3
  114. data/lib/clever-ruby/models/section.rb +25 -25
  115. data/lib/clever-ruby/models/section_object.rb +3 -3
  116. data/lib/clever-ruby/models/section_response.rb +3 -3
  117. data/lib/clever-ruby/models/sections_response.rb +3 -3
  118. data/lib/clever-ruby/models/student.rb +34 -34
  119. data/lib/clever-ruby/models/student_object.rb +3 -3
  120. data/lib/clever-ruby/models/student_response.rb +3 -3
  121. data/lib/clever-ruby/models/students_response.rb +3 -3
  122. data/lib/clever-ruby/models/teacher.rb +25 -25
  123. data/lib/clever-ruby/models/teacher_object.rb +3 -3
  124. data/lib/clever-ruby/models/teacher_response.rb +3 -3
  125. data/lib/clever-ruby/models/teachers_response.rb +3 -3
  126. data/lib/clever-ruby/models/term.rb +25 -25
  127. data/lib/clever-ruby/models/term_object.rb +3 -3
  128. data/lib/clever-ruby/models/term_response.rb +3 -3
  129. data/lib/clever-ruby/models/terms_response.rb +3 -3
  130. data/lib/clever-ruby/version.rb +4 -4
  131. data/lib/clever-ruby.rb +13 -4
  132. data/override/README-extension.md +4 -5
  133. data/override/api_client.rb +1 -0
  134. data/override/override.sh +4 -5
  135. data/spec/api/contacts_api_spec.rb +84 -0
  136. data/spec/api/courses_api_spec.rb +84 -0
  137. data/spec/api/district_admins_api_spec.rb +70 -0
  138. data/spec/api/districts_api_spec.rb +56 -0
  139. data/spec/api/events_api_spec.rb +60 -0
  140. data/spec/api/school_admins_api_spec.rb +84 -0
  141. data/spec/api/schools_api_spec.rb +112 -0
  142. data/spec/api/sections_api_spec.rb +142 -0
  143. data/spec/api/students_api_spec.rb +137 -0
  144. data/spec/api/teachers_api_spec.rb +123 -0
  145. data/spec/api/terms_api_spec.rb +84 -0
  146. data/spec/api_client_spec.rb +225 -0
  147. data/spec/spec_helper.rb +25 -18
  148. metadata +71 -33
  149. data/commonlit-clever-ruby-2.1.3.gem +0 -0
  150. data/docs/DataApi.md +0 -2852
  151. data/git_push.sh +0 -55
  152. data/lib/clever-ruby/api/data_api.rb +0 -2798
  153. data/spec/events.json +0 -227
  154. data/tags +0 -1681
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 315c6660b667c11c403ac02da71ada13e5ba40e66eb718da895f6286b6b18292
4
- data.tar.gz: 8684f2fa5089f88d7be4329f85a321671c5ee762ba74a9fd1bb0767fc64188f1
3
+ metadata.gz: e2e898b502d940a39ca0670dbb4bafc2ea0106874de9cee5a6a76a9f29fe75c8
4
+ data.tar.gz: d3d47d444eb1ebf9a8baa1c4c0d39d0f350547a390327a51c84e5567753c425b
5
5
  SHA512:
6
- metadata.gz: e6116b41acfb3366a02401fd60f113bc66a3aedb2650db000829dc90b38a37138c36800b6d8b1e9fdd20461a75b4352716893421fdae48c6e3be2e2ddfd49836
7
- data.tar.gz: 52b0a96585643b93f32afa3672c31ebed50b9d175e9a94b40f361c9b66c17f9c96589d7b68024f7dcdc03b7955c013adf1301138db4eb4276a01abd0ca4342da
6
+ metadata.gz: 229a5241ce0d90a1c01c7e681077151909f83ca70f6d819213ee84e0668f67faf62c659d83de3bb74dd58eeb265cc3cb1ea1c3bcba4f9aff4597d37420419e91
7
+ data.tar.gz: dfefc08f201ca6ca309c9d13c94ce55f17ef38be0a248bc4716a906f9492efff56769559d6779da8d84fcea30e0382ef0cb400ce836cf95084d9aca0f2958bca
data/Gemfile.lock CHANGED
@@ -1,36 +1,34 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- clever-ruby (2.1.0)
4
+ commonlit-clever-ruby (2.1.4)
5
+ addressable (~> 2.3, >= 2.3.0)
5
6
  json (~> 2.1, >= 2.1.0)
6
7
  typhoeus (~> 1.0, >= 1.0.1)
7
8
 
8
9
  GEM
9
10
  remote: https://rubygems.org/
10
11
  specs:
11
- addressable (2.4.0)
12
- autotest (5.0.0)
13
- minitest-autotest (~> 1.0)
14
- autotest-fsevent (0.2.17)
12
+ ZenTest (4.12.1)
13
+ addressable (2.8.5)
14
+ public_suffix (>= 2.0.2, < 6.0)
15
+ autotest (4.4.6)
16
+ ZenTest (>= 4.4.1)
17
+ autotest-fsevent (0.2.20)
15
18
  sys-uname
16
19
  autotest-growl (0.2.16)
17
20
  autotest-rails-pure (4.1.2)
18
- crack (0.4.3)
19
- safe_yaml (~> 1.0.0)
21
+ crack (0.4.5)
22
+ rexml
20
23
  diff-lcs (1.3)
21
- ethon (0.12.0)
22
- ffi (>= 1.3.0)
23
- ffi (1.13.1)
24
- hashdiff (0.3.8)
25
- json (2.3.0)
26
- minitest (5.12.0)
27
- minitest-autotest (1.1.1)
28
- minitest-server (~> 1.0)
29
- path_expander (~> 1.0)
30
- minitest-server (1.0.6)
31
- minitest (~> 5.0)
32
- path_expander (1.1.0)
24
+ ethon (0.16.0)
25
+ ffi (>= 1.15.0)
26
+ ffi (1.16.3)
27
+ hashdiff (1.0.1)
28
+ json (2.6.3)
29
+ public_suffix (5.0.4)
33
30
  rake (12.3.3)
31
+ rexml (3.2.6)
34
32
  rspec (3.9.0)
35
33
  rspec-core (~> 3.9.0)
36
34
  rspec-expectations (~> 3.9.0)
@@ -44,13 +42,12 @@ GEM
44
42
  diff-lcs (>= 1.2.0, < 2.0)
45
43
  rspec-support (~> 3.9.0)
46
44
  rspec-support (3.9.3)
47
- safe_yaml (1.0.5)
48
- sys-uname (1.2.1)
49
- ffi (>= 1.0.0)
50
- typhoeus (1.4.0)
45
+ sys-uname (1.2.3)
46
+ ffi (~> 1.1)
47
+ typhoeus (1.4.1)
51
48
  ethon (>= 0.9.0)
52
- vcr (5.1.0)
53
- webmock (2.3.2)
49
+ vcr (3.0.3)
50
+ webmock (1.24.6)
54
51
  addressable (>= 2.3.6)
55
52
  crack (>= 0.3.2)
56
53
  hashdiff
@@ -59,15 +56,15 @@ PLATFORMS
59
56
  ruby
60
57
 
61
58
  DEPENDENCIES
62
- autotest (~> 5.0, >= 4.4.6)
59
+ autotest (~> 4.4, >= 4.4.6)
63
60
  autotest-fsevent (~> 0.2, >= 0.2.12)
64
61
  autotest-growl (~> 0.2, >= 0.2.16)
65
62
  autotest-rails-pure (~> 4.1, >= 4.1.2)
66
- clever-ruby!
63
+ commonlit-clever-ruby!
67
64
  rake (~> 12.3.3)
68
65
  rspec (~> 3.6, >= 3.6.0)
69
- vcr (~> 5.1, >= 3.0.1)
70
- webmock (~> 2.3, >= 1.24.3)
66
+ vcr (~> 3.0, >= 3.0.1)
67
+ webmock (~> 1.24, >= 1.24.3)
71
68
 
72
69
  BUNDLED WITH
73
- 1.15.3
70
+ 2.4.12
data/Makefile CHANGED
@@ -1,7 +1,7 @@
1
1
  .PHONY: all test build run
2
2
  SHELL := /bin/bash
3
3
 
4
- all: test build
4
+ all: build test
5
5
 
6
6
  test:
7
7
  bundle install && bundle exec rake spec
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # clever-ruby
2
2
 
3
- Clever - the Ruby gem for the Clever API
3
+ Clever - the Ruby gem for the Data API
4
4
 
5
- The Clever API
5
+ Serves the Clever Data API
6
6
 
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
@@ -60,7 +60,7 @@ Clever.configure do |config|
60
60
  config.access_token = 'YOUR ACCESS TOKEN'
61
61
  end
62
62
 
63
- api_instance = Clever::DataApi.new
63
+ api_instance = Clever::ContactsApi.new
64
64
 
65
65
  id = 'id_example' # String |
66
66
 
@@ -69,70 +69,70 @@ begin
69
69
  result = api_instance.get_contact(id)
70
70
  p result
71
71
  rescue Clever::ApiError => e
72
- puts "Exception when calling DataApi->get_contact: #{e}"
72
+ puts "Exception when calling ContactsApi->get_contact: #{e}"
73
73
  end
74
74
 
75
75
  ```
76
76
 
77
77
  ## Documentation for API Endpoints
78
78
 
79
- All URIs are relative to *https://api.clever.com/v2.1*
79
+ All URIs are relative to *https://api.clever.com*
80
80
 
81
81
  Class | Method | HTTP request | Description
82
82
  ------------ | ------------- | ------------- | -------------
83
- *Clever::DataApi* | [**get_contact**](docs/DataApi.md#get_contact) | **GET** /contacts/{id} |
84
- *Clever::DataApi* | [**get_contacts**](docs/DataApi.md#get_contacts) | **GET** /contacts |
85
- *Clever::DataApi* | [**get_contacts_for_student**](docs/DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
86
- *Clever::DataApi* | [**get_course**](docs/DataApi.md#get_course) | **GET** /courses/{id} |
87
- *Clever::DataApi* | [**get_course_for_section**](docs/DataApi.md#get_course_for_section) | **GET** /sections/{id}/course |
88
- *Clever::DataApi* | [**get_courses**](docs/DataApi.md#get_courses) | **GET** /courses |
89
- *Clever::DataApi* | [**get_district**](docs/DataApi.md#get_district) | **GET** /districts/{id} |
90
- *Clever::DataApi* | [**get_district_admin**](docs/DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
91
- *Clever::DataApi* | [**get_district_admins**](docs/DataApi.md#get_district_admins) | **GET** /district_admins |
92
- *Clever::DataApi* | [**get_district_for_contact**](docs/DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
93
- *Clever::DataApi* | [**get_district_for_course**](docs/DataApi.md#get_district_for_course) | **GET** /courses/{id}/district |
94
- *Clever::DataApi* | [**get_district_for_district_admin**](docs/DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
95
- *Clever::DataApi* | [**get_district_for_school**](docs/DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
96
- *Clever::DataApi* | [**get_district_for_school_admin**](docs/DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
97
- *Clever::DataApi* | [**get_district_for_section**](docs/DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
98
- *Clever::DataApi* | [**get_district_for_student**](docs/DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
99
- *Clever::DataApi* | [**get_district_for_teacher**](docs/DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
100
- *Clever::DataApi* | [**get_district_for_term**](docs/DataApi.md#get_district_for_term) | **GET** /terms/{id}/district |
101
- *Clever::DataApi* | [**get_districts**](docs/DataApi.md#get_districts) | **GET** /districts |
102
- *Clever::DataApi* | [**get_school**](docs/DataApi.md#get_school) | **GET** /schools/{id} |
103
- *Clever::DataApi* | [**get_school_admin**](docs/DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
104
- *Clever::DataApi* | [**get_school_admins**](docs/DataApi.md#get_school_admins) | **GET** /school_admins |
105
- *Clever::DataApi* | [**get_school_for_section**](docs/DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
106
- *Clever::DataApi* | [**get_school_for_student**](docs/DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
107
- *Clever::DataApi* | [**get_school_for_teacher**](docs/DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
108
- *Clever::DataApi* | [**get_schools**](docs/DataApi.md#get_schools) | **GET** /schools |
109
- *Clever::DataApi* | [**get_schools_for_school_admin**](docs/DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
110
- *Clever::DataApi* | [**get_schools_for_student**](docs/DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
111
- *Clever::DataApi* | [**get_schools_for_teacher**](docs/DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
112
- *Clever::DataApi* | [**get_section**](docs/DataApi.md#get_section) | **GET** /sections/{id} |
113
- *Clever::DataApi* | [**get_sections**](docs/DataApi.md#get_sections) | **GET** /sections |
114
- *Clever::DataApi* | [**get_sections_for_course**](docs/DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
115
- *Clever::DataApi* | [**get_sections_for_school**](docs/DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
116
- *Clever::DataApi* | [**get_sections_for_student**](docs/DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
117
- *Clever::DataApi* | [**get_sections_for_teacher**](docs/DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
118
- *Clever::DataApi* | [**get_sections_for_term**](docs/DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
119
- *Clever::DataApi* | [**get_student**](docs/DataApi.md#get_student) | **GET** /students/{id} |
120
- *Clever::DataApi* | [**get_students**](docs/DataApi.md#get_students) | **GET** /students |
121
- *Clever::DataApi* | [**get_students_for_contact**](docs/DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
122
- *Clever::DataApi* | [**get_students_for_school**](docs/DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
123
- *Clever::DataApi* | [**get_students_for_section**](docs/DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
124
- *Clever::DataApi* | [**get_students_for_teacher**](docs/DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
125
- *Clever::DataApi* | [**get_teacher**](docs/DataApi.md#get_teacher) | **GET** /teachers/{id} |
126
- *Clever::DataApi* | [**get_teacher_for_section**](docs/DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
127
- *Clever::DataApi* | [**get_teachers**](docs/DataApi.md#get_teachers) | **GET** /teachers |
128
- *Clever::DataApi* | [**get_teachers_for_school**](docs/DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
129
- *Clever::DataApi* | [**get_teachers_for_section**](docs/DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
130
- *Clever::DataApi* | [**get_teachers_for_student**](docs/DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
131
- *Clever::DataApi* | [**get_term**](docs/DataApi.md#get_term) | **GET** /terms/{id} |
132
- *Clever::DataApi* | [**get_term_for_section**](docs/DataApi.md#get_term_for_section) | **GET** /sections/{id}/term |
133
- *Clever::DataApi* | [**get_terms**](docs/DataApi.md#get_terms) | **GET** /terms |
83
+ *Clever::ContactsApi* | [**get_contact**](docs/ContactsApi.md#get_contact) | **GET** /contacts/{id} |
84
+ *Clever::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts |
85
+ *Clever::ContactsApi* | [**get_district_for_contact**](docs/ContactsApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
86
+ *Clever::ContactsApi* | [**get_students_for_contact**](docs/ContactsApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
87
+ *Clever::CoursesApi* | [**get_course**](docs/CoursesApi.md#get_course) | **GET** /courses/{id} |
88
+ *Clever::CoursesApi* | [**get_courses**](docs/CoursesApi.md#get_courses) | **GET** /courses |
89
+ *Clever::CoursesApi* | [**get_district_for_course**](docs/CoursesApi.md#get_district_for_course) | **GET** /courses/{id}/district |
90
+ *Clever::CoursesApi* | [**get_sections_for_course**](docs/CoursesApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
91
+ *Clever::DistrictAdminsApi* | [**get_district_admin**](docs/DistrictAdminsApi.md#get_district_admin) | **GET** /district_admins/{id} |
92
+ *Clever::DistrictAdminsApi* | [**get_district_admins**](docs/DistrictAdminsApi.md#get_district_admins) | **GET** /district_admins |
93
+ *Clever::DistrictAdminsApi* | [**get_district_for_district_admin**](docs/DistrictAdminsApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
94
+ *Clever::DistrictsApi* | [**get_district**](docs/DistrictsApi.md#get_district) | **GET** /districts/{id} |
95
+ *Clever::DistrictsApi* | [**get_districts**](docs/DistrictsApi.md#get_districts) | **GET** /districts |
134
96
  *Clever::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} |
135
97
  *Clever::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events |
98
+ *Clever::SchoolAdminsApi* | [**get_district_for_school_admin**](docs/SchoolAdminsApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
99
+ *Clever::SchoolAdminsApi* | [**get_school_admin**](docs/SchoolAdminsApi.md#get_school_admin) | **GET** /school_admins/{id} |
100
+ *Clever::SchoolAdminsApi* | [**get_school_admins**](docs/SchoolAdminsApi.md#get_school_admins) | **GET** /school_admins |
101
+ *Clever::SchoolAdminsApi* | [**get_schools_for_school_admin**](docs/SchoolAdminsApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
102
+ *Clever::SchoolsApi* | [**get_district_for_school**](docs/SchoolsApi.md#get_district_for_school) | **GET** /schools/{id}/district |
103
+ *Clever::SchoolsApi* | [**get_school**](docs/SchoolsApi.md#get_school) | **GET** /schools/{id} |
104
+ *Clever::SchoolsApi* | [**get_schools**](docs/SchoolsApi.md#get_schools) | **GET** /schools |
105
+ *Clever::SchoolsApi* | [**get_sections_for_school**](docs/SchoolsApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
106
+ *Clever::SchoolsApi* | [**get_students_for_school**](docs/SchoolsApi.md#get_students_for_school) | **GET** /schools/{id}/students |
107
+ *Clever::SchoolsApi* | [**get_teachers_for_school**](docs/SchoolsApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
108
+ *Clever::SectionsApi* | [**get_course_for_section**](docs/SectionsApi.md#get_course_for_section) | **GET** /sections/{id}/course |
109
+ *Clever::SectionsApi* | [**get_district_for_section**](docs/SectionsApi.md#get_district_for_section) | **GET** /sections/{id}/district |
110
+ *Clever::SectionsApi* | [**get_school_for_section**](docs/SectionsApi.md#get_school_for_section) | **GET** /sections/{id}/school |
111
+ *Clever::SectionsApi* | [**get_section**](docs/SectionsApi.md#get_section) | **GET** /sections/{id} |
112
+ *Clever::SectionsApi* | [**get_sections**](docs/SectionsApi.md#get_sections) | **GET** /sections |
113
+ *Clever::SectionsApi* | [**get_students_for_section**](docs/SectionsApi.md#get_students_for_section) | **GET** /sections/{id}/students |
114
+ *Clever::SectionsApi* | [**get_teacher_for_section**](docs/SectionsApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
115
+ *Clever::SectionsApi* | [**get_teachers_for_section**](docs/SectionsApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
116
+ *Clever::SectionsApi* | [**get_term_for_section**](docs/SectionsApi.md#get_term_for_section) | **GET** /sections/{id}/term |
117
+ *Clever::StudentsApi* | [**get_contacts_for_student**](docs/StudentsApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
118
+ *Clever::StudentsApi* | [**get_district_for_student**](docs/StudentsApi.md#get_district_for_student) | **GET** /students/{id}/district |
119
+ *Clever::StudentsApi* | [**get_school_for_student**](docs/StudentsApi.md#get_school_for_student) | **GET** /students/{id}/school |
120
+ *Clever::StudentsApi* | [**get_schools_for_student**](docs/StudentsApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
121
+ *Clever::StudentsApi* | [**get_sections_for_student**](docs/StudentsApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
122
+ *Clever::StudentsApi* | [**get_student**](docs/StudentsApi.md#get_student) | **GET** /students/{id} |
123
+ *Clever::StudentsApi* | [**get_students**](docs/StudentsApi.md#get_students) | **GET** /students |
124
+ *Clever::StudentsApi* | [**get_teachers_for_student**](docs/StudentsApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
125
+ *Clever::TeachersApi* | [**get_district_for_teacher**](docs/TeachersApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
126
+ *Clever::TeachersApi* | [**get_school_for_teacher**](docs/TeachersApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
127
+ *Clever::TeachersApi* | [**get_schools_for_teacher**](docs/TeachersApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
128
+ *Clever::TeachersApi* | [**get_sections_for_teacher**](docs/TeachersApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
129
+ *Clever::TeachersApi* | [**get_students_for_teacher**](docs/TeachersApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
130
+ *Clever::TeachersApi* | [**get_teacher**](docs/TeachersApi.md#get_teacher) | **GET** /teachers/{id} |
131
+ *Clever::TeachersApi* | [**get_teachers**](docs/TeachersApi.md#get_teachers) | **GET** /teachers |
132
+ *Clever::TermsApi* | [**get_district_for_term**](docs/TermsApi.md#get_district_for_term) | **GET** /terms/{id}/district |
133
+ *Clever::TermsApi* | [**get_sections_for_term**](docs/TermsApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
134
+ *Clever::TermsApi* | [**get_term**](docs/TermsApi.md#get_term) | **GET** /terms/{id} |
135
+ *Clever::TermsApi* | [**get_terms**](docs/TermsApi.md#get_terms) | **GET** /terms |
136
136
 
137
137
 
138
138
  ## Documentation for Models
@@ -236,9 +236,8 @@ Class | Method | HTTP request | Description
236
236
 
237
237
  The current client support v2.0 of the API. For v1.2 please use:
238
238
 
239
- - https://rubygems.org/gems/clever-ruby/versions/1.2.4
240
- - https://github.com/Clever/clever-ruby/tree/v1.2.4
241
-
239
+ - https://rubygems.org/gems/clever-ruby/versions/1.2.4
240
+ - https://github.com/Clever/clever-ruby/tree/v1.2.4
242
241
 
243
242
  ## Updating the Library
244
243
 
@@ -247,13 +246,13 @@ The current client support v2.0 of the API. For v1.2 please use:
247
246
  2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
248
247
 
249
248
  3. Run this command in the swagger-codegen repo
249
+
250
250
  ```
251
- java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v2.0-client.yml -l ruby -o $PATH_TO_THIS_REPO --additional-properties gemVersion=$VERSION
251
+ swagger-codegen generate -i $PATH_TO_SWAGGER_API_REPO/full-v2.yml -l ruby -o $PATH_TO_THIS_REPO --additional-properties gemVersion=$VERSION
252
252
  ```
253
253
 
254
254
  4. Run `make build` to copy over the override files
255
255
 
256
-
257
256
  ## Publishing
258
257
 
259
258
  Signup to rubygems.org if you don't already have an account, and ask one of the gem [owners](https://rubygems.org/gems/clever-ruby) to add you as an owner. You'll be prompted to log in from the command line when you push the gem, if you aren't already logged in.
data/clever-ruby.gemspec CHANGED
@@ -1,14 +1,14 @@
1
1
  # -*- encoding: utf-8 -*-
2
2
 
3
3
  =begin
4
- #Clever API
4
+ #Data API
5
5
 
6
- #The Clever API
6
+ #Serves the Clever Data API
7
7
 
8
8
  OpenAPI spec version: 2.1.0
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
- Swagger Codegen version: 2.4.18
11
+ Swagger Codegen version: 2.4.37
12
12
 
13
13
  =end
14
14
 
@@ -22,10 +22,10 @@ Gem::Specification.new do |s|
22
22
  s.authors = ["Swagger-Codegen"]
23
23
  s.email = [""]
24
24
  s.homepage = "https://github.com/swagger-api/swagger-codegen"
25
- s.summary = "Clever API Ruby Gem"
26
- s.description = "The Clever API"
25
+ s.summary = "Data API Ruby Gem"
26
+ s.description = "Serves the Clever Data API"
27
27
  s.license = "Unlicense"
28
- s.required_ruby_version = ">= 2.1"
28
+ s.required_ruby_version = ">= 1.9"
29
29
 
30
30
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
31
  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
data/docs/Contact.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
6
7
  **district** | **String** | | [optional]
7
8
  **email** | **String** | | [optional]
8
- **id** | **String** | | [optional]
9
9
  **name** | **String** | | [optional]
10
10
  **phone** | **String** | | [optional]
11
11
  **phone_type** | **String** | | [optional]
@@ -0,0 +1,231 @@
1
+ # Clever::ContactsApi
2
+
3
+ All URIs are relative to *https://api.clever.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_contact**](ContactsApi.md#get_contact) | **GET** /contacts/{id} |
8
+ [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts |
9
+ [**get_district_for_contact**](ContactsApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
10
+ [**get_students_for_contact**](ContactsApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
11
+
12
+
13
+ # **get_contact**
14
+ > ContactResponse get_contact(id)
15
+
16
+
17
+
18
+ Returns a specific student contact
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'clever-ruby'
24
+ # setup authorization
25
+ Clever.configure do |config|
26
+ # Configure OAuth2 access token for authorization: oauth
27
+ config.access_token = 'YOUR ACCESS TOKEN'
28
+ end
29
+
30
+ api_instance = Clever::ContactsApi.new
31
+
32
+ id = 'id_example' # String |
33
+
34
+
35
+ begin
36
+ result = api_instance.get_contact(id)
37
+ p result
38
+ rescue Clever::ApiError => e
39
+ puts "Exception when calling ContactsApi->get_contact: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **id** | **String**| |
48
+
49
+ ### Return type
50
+
51
+ [**ContactResponse**](ContactResponse.md)
52
+
53
+ ### Authorization
54
+
55
+ [oauth](../README.md#oauth)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
61
+
62
+
63
+
64
+ # **get_contacts**
65
+ > ContactsResponse get_contacts(opts)
66
+
67
+
68
+
69
+ Returns a list of student contacts
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'clever-ruby'
75
+ # setup authorization
76
+ Clever.configure do |config|
77
+ # Configure OAuth2 access token for authorization: oauth
78
+ config.access_token = 'YOUR ACCESS TOKEN'
79
+ end
80
+
81
+ api_instance = Clever::ContactsApi.new
82
+
83
+ opts = {
84
+ limit: 56, # Integer |
85
+ starting_after: 'starting_after_example', # String |
86
+ ending_before: 'ending_before_example', # String |
87
+ count: 'count_example' # String |
88
+ }
89
+
90
+ begin
91
+ result = api_instance.get_contacts(opts)
92
+ p result
93
+ rescue Clever::ApiError => e
94
+ puts "Exception when calling ContactsApi->get_contacts: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **limit** | **Integer**| | [optional]
103
+ **starting_after** | **String**| | [optional]
104
+ **ending_before** | **String**| | [optional]
105
+ **count** | **String**| | [optional]
106
+
107
+ ### Return type
108
+
109
+ [**ContactsResponse**](ContactsResponse.md)
110
+
111
+ ### Authorization
112
+
113
+ [oauth](../README.md#oauth)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: Not defined
118
+ - **Accept**: application/json
119
+
120
+
121
+
122
+ # **get_district_for_contact**
123
+ > DistrictResponse get_district_for_contact(id)
124
+
125
+
126
+
127
+ Returns the district for a student contact
128
+
129
+ ### Example
130
+ ```ruby
131
+ # load the gem
132
+ require 'clever-ruby'
133
+ # setup authorization
134
+ Clever.configure do |config|
135
+ # Configure OAuth2 access token for authorization: oauth
136
+ config.access_token = 'YOUR ACCESS TOKEN'
137
+ end
138
+
139
+ api_instance = Clever::ContactsApi.new
140
+
141
+ id = 'id_example' # String |
142
+
143
+
144
+ begin
145
+ result = api_instance.get_district_for_contact(id)
146
+ p result
147
+ rescue Clever::ApiError => e
148
+ puts "Exception when calling ContactsApi->get_district_for_contact: #{e}"
149
+ end
150
+ ```
151
+
152
+ ### Parameters
153
+
154
+ Name | Type | Description | Notes
155
+ ------------- | ------------- | ------------- | -------------
156
+ **id** | **String**| |
157
+
158
+ ### Return type
159
+
160
+ [**DistrictResponse**](DistrictResponse.md)
161
+
162
+ ### Authorization
163
+
164
+ [oauth](../README.md#oauth)
165
+
166
+ ### HTTP request headers
167
+
168
+ - **Content-Type**: Not defined
169
+ - **Accept**: application/json
170
+
171
+
172
+
173
+ # **get_students_for_contact**
174
+ > StudentsResponse get_students_for_contact(id, opts)
175
+
176
+
177
+
178
+ Returns the students for a student contact
179
+
180
+ ### Example
181
+ ```ruby
182
+ # load the gem
183
+ require 'clever-ruby'
184
+ # setup authorization
185
+ Clever.configure do |config|
186
+ # Configure OAuth2 access token for authorization: oauth
187
+ config.access_token = 'YOUR ACCESS TOKEN'
188
+ end
189
+
190
+ api_instance = Clever::ContactsApi.new
191
+
192
+ id = 'id_example' # String |
193
+
194
+ opts = {
195
+ limit: 56, # Integer |
196
+ starting_after: 'starting_after_example', # String |
197
+ ending_before: 'ending_before_example' # String |
198
+ }
199
+
200
+ begin
201
+ result = api_instance.get_students_for_contact(id, opts)
202
+ p result
203
+ rescue Clever::ApiError => e
204
+ puts "Exception when calling ContactsApi->get_students_for_contact: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ Name | Type | Description | Notes
211
+ ------------- | ------------- | ------------- | -------------
212
+ **id** | **String**| |
213
+ **limit** | **Integer**| | [optional]
214
+ **starting_after** | **String**| | [optional]
215
+ **ending_before** | **String**| | [optional]
216
+
217
+ ### Return type
218
+
219
+ [**StudentsResponse**](StudentsResponse.md)
220
+
221
+ ### Authorization
222
+
223
+ [oauth](../README.md#oauth)
224
+
225
+ ### HTTP request headers
226
+
227
+ - **Content-Type**: Not defined
228
+ - **Accept**: application/json
229
+
230
+
231
+
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **created** | **String** | | [optional]
7
- **id** | **String** | | [optional]
8
6
  **type** | **String** | |
7
+ **id** | **String** | | [optional]
8
+ **created** | **String** | | [optional]
9
9
  **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
10
 
11
11
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **created** | **String** | | [optional]
7
- **id** | **String** | | [optional]
8
6
  **type** | **String** | |
7
+ **id** | **String** | | [optional]
8
+ **created** | **String** | | [optional]
9
9
  **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
10
 
11
11
 
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **created** | **String** | | [optional]
7
- **id** | **String** | | [optional]
8
6
  **type** | **String** | |
7
+ **id** | **String** | | [optional]
8
+ **created** | **String** | | [optional]
9
9
  **data** | [**ContactObject**](ContactObject.md) | | [optional]
10
10
  **previous_attributes** | **Object** | | [optional]
11
11
 
data/docs/Course.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **district** | **String** | | [optional]
7
6
  **id** | **String** | | [optional]
8
7
  **name** | **String** | | [optional]
9
8
  **number** | **String** | | [optional]
9
+ **district** | **String** | | [optional]
10
10
 
11
11