clever-ruby 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/README.md +78 -46
  4. data/clever-ruby-1.0.0.gem +0 -0
  5. data/docs/Credentials.md +8 -0
  6. data/docs/DataApi.md +130 -127
  7. data/docs/District.md +1 -1
  8. data/docs/DistrictAdmin.md +2 -2
  9. data/docs/DistrictStatus.md +5 -5
  10. data/docs/DistrictsCreated.md +2 -1
  11. data/docs/DistrictsDeleted.md +2 -1
  12. data/docs/DistrictsUpdated.md +2 -1
  13. data/docs/Event.md +2 -1
  14. data/docs/EventsApi.md +14 -21
  15. data/docs/Location.md +2 -2
  16. data/docs/Name.md +1 -1
  17. data/docs/Principal.md +1 -1
  18. data/docs/School.md +2 -2
  19. data/docs/SchoolAdmin.md +2 -1
  20. data/docs/SchooladminsCreated.md +2 -1
  21. data/docs/SchooladminsDeleted.md +2 -1
  22. data/docs/SchooladminsUpdated.md +2 -1
  23. data/docs/SchoolsCreated.md +2 -1
  24. data/docs/SchoolsDeleted.md +2 -1
  25. data/docs/SchoolsUpdated.md +2 -1
  26. data/docs/Section.md +1 -1
  27. data/docs/SectionsCreated.md +2 -1
  28. data/docs/SectionsDeleted.md +2 -1
  29. data/docs/SectionsUpdated.md +2 -1
  30. data/docs/Student.md +2 -2
  31. data/docs/StudentContact.md +1 -1
  32. data/docs/StudentcontactsCreated.md +2 -1
  33. data/docs/StudentcontactsDeleted.md +2 -1
  34. data/docs/StudentcontactsUpdated.md +2 -1
  35. data/docs/StudentsCreated.md +2 -1
  36. data/docs/StudentsDeleted.md +2 -1
  37. data/docs/StudentsUpdated.md +2 -1
  38. data/docs/Teacher.md +2 -1
  39. data/docs/TeachersCreated.md +2 -1
  40. data/docs/TeachersDeleted.md +2 -1
  41. data/docs/TeachersUpdated.md +2 -1
  42. data/docs/Term.md +1 -1
  43. data/lib/clever-ruby.rb +1 -0
  44. data/lib/clever-ruby/api/data_api.rb +127 -85
  45. data/lib/clever-ruby/api/events_api.rb +14 -14
  46. data/lib/clever-ruby/models/credentials.rb +187 -0
  47. data/lib/clever-ruby/models/district.rb +13 -13
  48. data/lib/clever-ruby/models/district_admin.rb +22 -22
  49. data/lib/clever-ruby/models/district_status.rb +70 -37
  50. data/lib/clever-ruby/models/event.rb +19 -10
  51. data/lib/clever-ruby/models/location.rb +22 -22
  52. data/lib/clever-ruby/models/name.rb +13 -13
  53. data/lib/clever-ruby/models/principal.rb +13 -13
  54. data/lib/clever-ruby/models/school.rb +66 -21
  55. data/lib/clever-ruby/models/school_admin.rb +16 -7
  56. data/lib/clever-ruby/models/section.rb +55 -10
  57. data/lib/clever-ruby/models/student.rb +100 -19
  58. data/lib/clever-ruby/models/student_contact.rb +10 -10
  59. data/lib/clever-ruby/models/teacher.rb +19 -10
  60. data/lib/clever-ruby/models/term.rb +13 -13
  61. data/lib/clever-ruby/version.rb +1 -1
  62. data/override/README-extension.md +31 -0
  63. data/override/config.json +1 -1
  64. data/override/override.sh +5 -0
  65. data/sample/sample.rb +1 -1
  66. metadata +6 -3
  67. data/instructions.md +0 -12
data/docs/District.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | | [optional]
7
- **name** | **String** | | [optional]
8
7
  **mdr_number** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
9
 
10
10
 
data/docs/DistrictAdmin.md CHANGED
@@ -3,10 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **district** | **String** | | [optional]
7
+ **email** | **String** | | [optional]
6
8
  **id** | **String** | | [optional]
7
9
  **name** | [**Name**](Name.md) | | [optional]
8
- **email** | **String** | | [optional]
9
10
  **title** | **String** | | [optional]
10
- **district** | **String** | | [optional]
11
11
 
12
12
 
data/docs/DistrictStatus.md CHANGED
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **error** | **String** | | [optional]
6
7
  **id** | **String** | | [optional]
7
- **sis_type** | **String** | | [optional]
8
- **state** | **String** | | [optional]
9
8
  **last_sync** | **String** | | [optional]
10
- **error** | **String** | | [optional]
11
- **pause_start** | **String** | | [optional]
9
+ **launch_date** | **String** | | [optional]
12
10
  **pause_end** | **String** | | [optional]
13
- **launch_state** | **String** | | [optional]
11
+ **pause_start** | **String** | | [optional]
12
+ **sis_type** | **String** | | [optional]
13
+ **state** | **String** | | [optional]
14
14
 
15
15
 
data/docs/DistrictsCreated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**DistrictObject**](DistrictObject.md) | | [optional]
9
10
 
10
11
 
data/docs/DistrictsDeleted.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**DistrictObject**](DistrictObject.md) | | [optional]
9
10
 
10
11
 
data/docs/DistrictsUpdated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**DistrictObject**](DistrictObject.md) | | [optional]
9
10
 
10
11
 
data/docs/Event.md CHANGED
@@ -3,7 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
 
9
10
 
data/docs/EventsApi.md CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *https://api.clever.com/v1.2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_event**](EventsApi.md#get_event) | **GET** /events/{id} | Retrieves a single event.
8
- [**get_events**](EventsApi.md#get_events) | **GET** /events | Retrieves all events
9
- [**get_events_for_school**](EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events | Retrieves events for schools.
10
- [**get_events_for_school_admin**](EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events | Retrieves events for school_admins.
11
- [**get_events_for_section**](EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events | Retrieves events for sections.
12
- [**get_events_for_student**](EventsApi.md#get_events_for_student) | **GET** /students/{id}/events | Retrieves events for students.
13
- [**get_events_for_teacher**](EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events | Retrieves events for teachers.
7
+ [**get_event**](EventsApi.md#get_event) | **GET** /events/{id} |
8
+ [**get_events**](EventsApi.md#get_events) | **GET** /events |
9
+ [**get_events_for_school**](EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events |
10
+ [**get_events_for_school_admin**](EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events |
11
+ [**get_events_for_section**](EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events |
12
+ [**get_events_for_student**](EventsApi.md#get_events_for_student) | **GET** /students/{id}/events |
13
+ [**get_events_for_teacher**](EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events |
14
14
 
15
15
 
16
16
  # **get_event**
17
17
  > EventResponse get_event(id)
18
18
 
19
- Retrieves a single event.
19
+
20
20
 
21
21
  Returns the specific event
22
22
 
@@ -36,7 +36,6 @@ id = "id_example" # String |
36
36
 
37
37
 
38
38
  begin
39
- #Retrieves a single event.
40
39
  result = api_instance.get_event(id)
41
40
  p result
42
41
  rescue Clever::ApiError => e
@@ -68,7 +67,7 @@ Name | Type | Description | Notes
68
67
  # **get_events**
69
68
  > EventsResponse get_events(opts)
70
69
 
71
- Retrieves all events
70
+
72
71
 
73
72
  Returns a list of events
74
73
 
@@ -91,7 +90,6 @@ opts = {
91
90
  }
92
91
 
93
92
  begin
94
- #Retrieves all events
95
93
  result = api_instance.get_events(opts)
96
94
  p result
97
95
  rescue Clever::ApiError => e
@@ -125,7 +123,7 @@ Name | Type | Description | Notes
125
123
  # **get_events_for_school**
126
124
  > EventsResponse get_events_for_school(id, opts)
127
125
 
128
- Retrieves events for schools.
126
+
129
127
 
130
128
  Returns a list of events for a school
131
129
 
@@ -150,7 +148,6 @@ opts = {
150
148
  }
151
149
 
152
150
  begin
153
- #Retrieves events for schools.
154
151
  result = api_instance.get_events_for_school(id, opts)
155
152
  p result
156
153
  rescue Clever::ApiError => e
@@ -185,7 +182,7 @@ Name | Type | Description | Notes
185
182
  # **get_events_for_school_admin**
186
183
  > EventsResponse get_events_for_school_admin(id, opts)
187
184
 
188
- Retrieves events for school_admins.
185
+
189
186
 
190
187
  Returns a list of events for a school admin
191
188
 
@@ -210,7 +207,6 @@ opts = {
210
207
  }
211
208
 
212
209
  begin
213
- #Retrieves events for school_admins.
214
210
  result = api_instance.get_events_for_school_admin(id, opts)
215
211
  p result
216
212
  rescue Clever::ApiError => e
@@ -245,7 +241,7 @@ Name | Type | Description | Notes
245
241
  # **get_events_for_section**
246
242
  > EventsResponse get_events_for_section(id, opts)
247
243
 
248
- Retrieves events for sections.
244
+
249
245
 
250
246
  Returns a list of events for a section
251
247
 
@@ -270,7 +266,6 @@ opts = {
270
266
  }
271
267
 
272
268
  begin
273
- #Retrieves events for sections.
274
269
  result = api_instance.get_events_for_section(id, opts)
275
270
  p result
276
271
  rescue Clever::ApiError => e
@@ -305,7 +300,7 @@ Name | Type | Description | Notes
305
300
  # **get_events_for_student**
306
301
  > EventsResponse get_events_for_student(id, opts)
307
302
 
308
- Retrieves events for students.
303
+
309
304
 
310
305
  Returns a list of events for a student
311
306
 
@@ -330,7 +325,6 @@ opts = {
330
325
  }
331
326
 
332
327
  begin
333
- #Retrieves events for students.
334
328
  result = api_instance.get_events_for_student(id, opts)
335
329
  p result
336
330
  rescue Clever::ApiError => e
@@ -365,7 +359,7 @@ Name | Type | Description | Notes
365
359
  # **get_events_for_teacher**
366
360
  > EventsResponse get_events_for_teacher(id, opts)
367
361
 
368
- Retrieves events for teachers.
362
+
369
363
 
370
364
  Returns a list of events for a teacher
371
365
 
@@ -390,7 +384,6 @@ opts = {
390
384
  }
391
385
 
392
386
  begin
393
- #Retrieves events for teachers.
394
387
  result = api_instance.get_events_for_teacher(id, opts)
395
388
  p result
396
389
  rescue Clever::ApiError => e
data/docs/Location.md CHANGED
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **address** | **String** | | [optional]
7
7
  **city** | **String** | | [optional]
8
- **state** | **String** | | [optional]
9
- **zip** | **String** | | [optional]
10
8
  **lat** | **String** | | [optional]
11
9
  **lon** | **String** | | [optional]
10
+ **state** | **String** | | [optional]
11
+ **zip** | **String** | | [optional]
12
12
 
13
13
 
data/docs/Name.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **first** | **String** | | [optional]
7
- **middle** | **String** | | [optional]
8
7
  **last** | **String** | | [optional]
8
+ **middle** | **String** | | [optional]
9
9
 
10
10
 
data/docs/Principal.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | | [optional]
7
6
  **email** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
8
 
9
9
 
data/docs/School.md CHANGED
@@ -3,13 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
6
  **created** | **String** | | [optional]
8
7
  **district** | **String** | | [optional]
9
8
  **high_grade** | **String** | | [optional]
9
+ **id** | **String** | | [optional]
10
10
  **last_modified** | **String** | | [optional]
11
11
  **location** | [**Location**](Location.md) | | [optional]
12
12
  **low_grade** | **String** | | [optional]
13
+ **mdr_number** | **String** | | [optional]
13
14
  **name** | **String** | | [optional]
14
15
  **nces_id** | **String** | | [optional]
15
16
  **phone** | **String** | | [optional]
@@ -17,6 +18,5 @@ Name | Type | Description | Notes
17
18
  **school_number** | **String** | | [optional]
18
19
  **sis_id** | **String** | | [optional]
19
20
  **state_id** | **String** | | [optional]
20
- **mdr_number** | **String** | | [optional]
21
21
 
22
22
 
data/docs/SchoolAdmin.md CHANGED
@@ -3,9 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
6
+ **credentials** | [**Credentials**](Credentials.md) | | [optional]
7
7
  **district** | **String** | | [optional]
8
8
  **email** | **String** | | [optional]
9
+ **id** | **String** | | [optional]
9
10
  **name** | [**Name**](Name.md) | | [optional]
10
11
  **schools** | **Array<String>** | | [optional]
11
12
  **staff_id** | **String** | | [optional]
data/docs/SchooladminsCreated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SchooladminsDeleted.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SchooladminsUpdated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolAdminObject**](SchoolAdminObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SchoolsCreated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SchoolsDeleted.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SchoolsUpdated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SchoolObject**](SchoolObject.md) | | [optional]
9
10
 
10
11
 
data/docs/Section.md CHANGED
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
6
  **course_description** | **String** | | [optional]
8
7
  **course_name** | **String** | | [optional]
9
8
  **course_number** | **String** | | [optional]
10
9
  **created** | **String** | | [optional]
11
10
  **district** | **String** | | [optional]
12
11
  **grade** | **String** | | [optional]
12
+ **id** | **String** | | [optional]
13
13
  **last_modified** | **String** | | [optional]
14
14
  **name** | **String** | | [optional]
15
15
  **period** | **String** | | [optional]
data/docs/SectionsCreated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SectionsDeleted.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
9
10
 
10
11
 
data/docs/SectionsUpdated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**SectionObject**](SectionObject.md) | | [optional]
9
10
 
10
11
 
data/docs/Student.md CHANGED
@@ -3,16 +3,16 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
6
  **created** | **String** | | [optional]
7
+ **credentials** | [**Credentials**](Credentials.md) | | [optional]
8
8
  **district** | **String** | | [optional]
9
9
  **dob** | **String** | | [optional]
10
10
  **ell_status** | **String** | | [optional]
11
11
  **email** | **String** | | [optional]
12
- **frl_status** | **String** | | [optional]
13
12
  **gender** | **String** | | [optional]
14
13
  **grade** | **String** | | [optional]
15
14
  **hispanic_ethnicity** | **String** | | [optional]
15
+ **id** | **String** | | [optional]
16
16
  **iep_status** | **String** | | [optional]
17
17
  **last_modified** | **String** | | [optional]
18
18
  **location** | [**Location**](Location.md) | | [optional]
data/docs/StudentContact.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
6
  **district** | **String** | | [optional]
8
7
  **email** | **String** | | [optional]
8
+ **id** | **String** | | [optional]
9
9
  **name** | **String** | | [optional]
10
10
  **phone** | **String** | | [optional]
11
11
  **phone_type** | **String** | | [optional]
data/docs/StudentcontactsCreated.md CHANGED
@@ -3,8 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | |
6
+ **created** | **String** | | [optional]
7
7
  **id** | **String** | | [optional]
8
+ **type** | **String** | |
8
9
  **data** | [**StudentContactObject**](StudentContactObject.md) | | [optional]
9
10
 
10
11