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
@@ -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
 
@@ -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
 
@@ -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** | [**StudentObject**](StudentObject.md) | | [optional]
9
10
 
10
11
 
@@ -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** | [**StudentObject**](StudentObject.md) | | [optional]
9
10
 
10
11
 
@@ -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** | [**StudentObject**](StudentObject.md) | | [optional]
9
10
 
10
11
 
@@ -3,10 +3,11 @@
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
  **email** | **String** | | [optional]
10
+ **id** | **String** | | [optional]
10
11
  **last_modified** | **String** | | [optional]
11
12
  **name** | [**Name**](Name.md) | | [optional]
12
13
  **school** | **String** | | [optional]
@@ -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** | [**TeacherObject**](TeacherObject.md) | | [optional]
9
10
 
10
11
 
@@ -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** | [**TeacherObject**](TeacherObject.md) | | [optional]
9
10
 
10
11
 
@@ -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** | [**TeacherObject**](TeacherObject.md) | | [optional]
9
10
 
10
11
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **end_date** | **String** | | [optional]
6
7
  **name** | **String** | | [optional]
7
8
  **start_date** | **String** | | [optional]
8
- **end_date** | **String** | | [optional]
9
9
 
10
10
 
@@ -17,6 +17,7 @@ require 'clever-ruby/configuration'
17
17
 
18
18
  # Models
19
19
  require 'clever-ruby/models/bad_request'
20
+ require 'clever-ruby/models/credentials'
20
21
  require 'clever-ruby/models/district'
21
22
  require 'clever-ruby/models/district_admin'
22
23
  require 'clever-ruby/models/district_admin_response'
@@ -19,7 +19,7 @@ module Clever
19
19
  @api_client = api_client
20
20
  end
21
21
 
22
- # Get only a specific studentcontact's information.
22
+ #
23
23
  # Returns a specific student contact
24
24
  # @param id
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module Clever
29
29
  return data
30
30
  end
31
31
 
32
- # Get only a specific studentcontact's information.
32
+ #
33
33
  # Returns a specific student contact
34
34
  # @param id
35
35
  # @param [Hash] opts the optional parameters
@@ -70,7 +70,7 @@ module Clever
70
70
  return data, status_code, headers
71
71
  end
72
72
 
73
- # Gets a list of student contacts you have access to.
73
+ #
74
74
  # Returns a list of student contacts
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @option opts [Integer] :limit
@@ -82,7 +82,7 @@ module Clever
82
82
  return data
83
83
  end
84
84
 
85
- # Gets a list of student contacts you have access to.
85
+ #
86
86
  # Returns a list of student contacts
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @option opts [Integer] :limit
@@ -126,7 +126,7 @@ module Clever
126
126
  return data, status_code, headers
127
127
  end
128
128
 
129
- # Retrieves all contacts for a student.
129
+ #
130
130
  # Returns the contacts for a student
131
131
  # @param id
132
132
  # @param [Hash] opts the optional parameters
@@ -137,7 +137,7 @@ module Clever
137
137
  return data
138
138
  end
139
139
 
140
- # Retrieves all contacts for a student.
140
+ #
141
141
  # Returns the contacts for a student
142
142
  # @param id
143
143
  # @param [Hash] opts the optional parameters
@@ -180,7 +180,7 @@ module Clever
180
180
  return data, status_code, headers
181
181
  end
182
182
 
183
- # Get only a specific district's information.
183
+ #
184
184
  # Returns a specific district
185
185
  # @param id
186
186
  # @param [Hash] opts the optional parameters
@@ -190,7 +190,7 @@ module Clever
190
190
  return data
191
191
  end
192
192
 
193
- # Get only a specific district's information.
193
+ #
194
194
  # Returns a specific district
195
195
  # @param id
196
196
  # @param [Hash] opts the optional parameters
@@ -231,7 +231,7 @@ module Clever
231
231
  return data, status_code, headers
232
232
  end
233
233
 
234
- # Retrieves a district admin
234
+ #
235
235
  # Returns a specific district admin
236
236
  # @param id
237
237
  # @param [Hash] opts the optional parameters
@@ -241,7 +241,7 @@ module Clever
241
241
  return data
242
242
  end
243
243
 
244
- # Retrieves a district admin
244
+ #
245
245
  # Returns a specific district admin
246
246
  # @param id
247
247
  # @param [Hash] opts the optional parameters
@@ -282,7 +282,7 @@ module Clever
282
282
  return data, status_code, headers
283
283
  end
284
284
 
285
- # Retrieves all users with admin access to a district.
285
+ #
286
286
  # Returns a list of district admins
287
287
  # @param [Hash] opts the optional parameters
288
288
  # @option opts [String] :starting_after
@@ -293,7 +293,7 @@ module Clever
293
293
  return data
294
294
  end
295
295
 
296
- # Retrieves all users with admin access to a district.
296
+ #
297
297
  # Returns a list of district admins
298
298
  # @param [Hash] opts the optional parameters
299
299
  # @option opts [String] :starting_after
@@ -335,7 +335,7 @@ module Clever
335
335
  return data, status_code, headers
336
336
  end
337
337
 
338
- # Retrieves district information for a school.
338
+ #
339
339
  # Returns the district for a school
340
340
  # @param id
341
341
  # @param [Hash] opts the optional parameters
@@ -345,7 +345,7 @@ module Clever
345
345
  return data
346
346
  end
347
347
 
348
- # Retrieves district information for a school.
348
+ #
349
349
  # Returns the district for a school
350
350
  # @param id
351
351
  # @param [Hash] opts the optional parameters
@@ -386,7 +386,7 @@ module Clever
386
386
  return data, status_code, headers
387
387
  end
388
388
 
389
- # Retrieves district information for a section.
389
+ #
390
390
  # Returns the district for a section
391
391
  # @param id
392
392
  # @param [Hash] opts the optional parameters
@@ -396,7 +396,7 @@ module Clever
396
396
  return data
397
397
  end
398
398
 
399
- # Retrieves district information for a section.
399
+ #
400
400
  # Returns the district for a section
401
401
  # @param id
402
402
  # @param [Hash] opts the optional parameters
@@ -437,7 +437,7 @@ module Clever
437
437
  return data, status_code, headers
438
438
  end
439
439
 
440
- # Retrieves district information for a student.
440
+ #
441
441
  # Returns the district for a student
442
442
  # @param id
443
443
  # @param [Hash] opts the optional parameters
@@ -447,7 +447,7 @@ module Clever
447
447
  return data
448
448
  end
449
449
 
450
- # Retrieves district information for a student.
450
+ #
451
451
  # Returns the district for a student
452
452
  # @param id
453
453
  # @param [Hash] opts the optional parameters
@@ -488,7 +488,7 @@ module Clever
488
488
  return data, status_code, headers
489
489
  end
490
490
 
491
- # Retrieves the district for a contact.
491
+ #
492
492
  # Returns the district for a student contact
493
493
  # @param id
494
494
  # @param [Hash] opts the optional parameters
@@ -498,7 +498,7 @@ module Clever
498
498
  return data
499
499
  end
500
500
 
501
- # Retrieves the district for a contact.
501
+ #
502
502
  # Returns the district for a student contact
503
503
  # @param id
504
504
  # @param [Hash] opts the optional parameters
@@ -539,7 +539,7 @@ module Clever
539
539
  return data, status_code, headers
540
540
  end
541
541
 
542
- # Retrieves district information for a teacher.
542
+ #
543
543
  # Returns the district for a teacher
544
544
  # @param id
545
545
  # @param [Hash] opts the optional parameters
@@ -549,7 +549,7 @@ module Clever
549
549
  return data
550
550
  end
551
551
 
552
- # Retrieves district information for a teacher.
552
+ #
553
553
  # Returns the district for a teacher
554
554
  # @param id
555
555
  # @param [Hash] opts the optional parameters
@@ -590,24 +590,69 @@ module Clever
590
590
  return data, status_code, headers
591
591
  end
592
592
 
593
- # Gets a list of districts you have access to.
593
+ #
594
+ # Returns the status of the district
595
+ # @param id
596
+ # @param [Hash] opts the optional parameters
597
+ # @return [DistrictStatusResponse]
598
+ def get_district_status(id, opts = {})
599
+ data, _status_code, _headers = get_district_status_with_http_info(id, opts)
600
+ return data
601
+ end
602
+
603
+ #
604
+ # Returns the status of the district
605
+ # @param id
606
+ # @param [Hash] opts the optional parameters
607
+ # @return [Array<(DistrictStatusResponse, Fixnum, Hash)>] DistrictStatusResponse data, response status code and response headers
608
+ def get_district_status_with_http_info(id, opts = {})
609
+ if @api_client.config.debugging
610
+ @api_client.config.logger.debug "Calling API: DataApi.get_district_status ..."
611
+ end
612
+ # verify the required parameter 'id' is set
613
+ fail ArgumentError, "Missing the required parameter 'id' when calling DataApi.get_district_status" if id.nil?
614
+ # resource path
615
+ local_var_path = "/districts/{id}/status".sub('{' + 'id' + '}', id.to_s)
616
+
617
+ # query parameters
618
+ query_params = {}
619
+
620
+ # header parameters
621
+ header_params = {}
622
+ # HTTP header 'Accept' (if needed)
623
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
624
+
625
+ # form parameters
626
+ form_params = {}
627
+
628
+ # http body (model)
629
+ post_body = nil
630
+ auth_names = ['oauth']
631
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
632
+ :header_params => header_params,
633
+ :query_params => query_params,
634
+ :form_params => form_params,
635
+ :body => post_body,
636
+ :auth_names => auth_names,
637
+ :return_type => 'DistrictStatusResponse')
638
+ if @api_client.config.debugging
639
+ @api_client.config.logger.debug "API called: DataApi#get_district_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
640
+ end
641
+ return data, status_code, headers
642
+ end
643
+
644
+ #
594
645
  # Returns a list of districts
595
646
  # @param [Hash] opts the optional parameters
596
- # @option opts [Integer] :limit
597
- # @option opts [String] :starting_after
598
- # @option opts [String] :ending_before
599
647
  # @return [DistrictsResponse]
600
648
  def get_districts(opts = {})
601
649
  data, _status_code, _headers = get_districts_with_http_info(opts)
602
650
  return data
603
651
  end
604
652
 
605
- # Gets a list of districts you have access to.
653
+ #
606
654
  # Returns a list of districts
607
655
  # @param [Hash] opts the optional parameters
608
- # @option opts [Integer] :limit
609
- # @option opts [String] :starting_after
610
- # @option opts [String] :ending_before
611
656
  # @return [Array<(DistrictsResponse, Fixnum, Hash)>] DistrictsResponse data, response status code and response headers
612
657
  def get_districts_with_http_info(opts = {})
613
658
  if @api_client.config.debugging
@@ -618,9 +663,6 @@ module Clever
618
663
 
619
664
  # query parameters
620
665
  query_params = {}
621
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
622
- query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
623
- query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
624
666
 
625
667
  # header parameters
626
668
  header_params = {}
@@ -646,7 +688,7 @@ module Clever
646
688
  return data, status_code, headers
647
689
  end
648
690
 
649
- # Retrieves a list of all grade levels taught by a specific teacher.
691
+ #
650
692
  # Returns the grade levels for sections a teacher teaches
651
693
  # @param id
652
694
  # @param [Hash] opts the optional parameters
@@ -656,7 +698,7 @@ module Clever
656
698
  return data
657
699
  end
658
700
 
659
- # Retrieves a list of all grade levels taught by a specific teacher.
701
+ #
660
702
  # Returns the grade levels for sections a teacher teaches
661
703
  # @param id
662
704
  # @param [Hash] opts the optional parameters
@@ -697,7 +739,7 @@ module Clever
697
739
  return data, status_code, headers
698
740
  end
699
741
 
700
- # Get only a specific school's information.
742
+ #
701
743
  # Returns a specific school
702
744
  # @param id
703
745
  # @param [Hash] opts the optional parameters
@@ -707,7 +749,7 @@ module Clever
707
749
  return data
708
750
  end
709
751
 
710
- # Get only a specific school&#39;s information.
752
+ #
711
753
  # Returns a specific school
712
754
  # @param id
713
755
  # @param [Hash] opts the optional parameters
@@ -748,7 +790,7 @@ module Clever
748
790
  return data, status_code, headers
749
791
  end
750
792
 
751
- # Get only a specific schooladmin's information.
793
+ #
752
794
  # Returns a specific school admin
753
795
  # @param id
754
796
  # @param [Hash] opts the optional parameters
@@ -758,7 +800,7 @@ module Clever
758
800
  return data
759
801
  end
760
802
 
761
- # Get only a specific schooladmin&#39;s information.
803
+ #
762
804
  # Returns a specific school admin
763
805
  # @param id
764
806
  # @param [Hash] opts the optional parameters
@@ -799,7 +841,7 @@ module Clever
799
841
  return data, status_code, headers
800
842
  end
801
843
 
802
- # Gets a list of school_admins you have access to.
844
+ #
803
845
  # Returns a list of school admins
804
846
  # @param [Hash] opts the optional parameters
805
847
  # @option opts [Integer] :limit
@@ -811,7 +853,7 @@ module Clever
811
853
  return data
812
854
  end
813
855
 
814
- # Gets a list of school_admins you have access to.
856
+ #
815
857
  # Returns a list of school admins
816
858
  # @param [Hash] opts the optional parameters
817
859
  # @option opts [Integer] :limit
@@ -855,7 +897,7 @@ module Clever
855
897
  return data, status_code, headers
856
898
  end
857
899
 
858
- # Retrieves information about the school for a section
900
+ #
859
901
  # Returns the school for a section
860
902
  # @param id
861
903
  # @param [Hash] opts the optional parameters
@@ -865,7 +907,7 @@ module Clever
865
907
  return data
866
908
  end
867
909
 
868
- # Retrieves information about the school for a section
910
+ #
869
911
  # Returns the school for a section
870
912
  # @param id
871
913
  # @param [Hash] opts the optional parameters
@@ -906,7 +948,7 @@ module Clever
906
948
  return data, status_code, headers
907
949
  end
908
950
 
909
- # Retrieves information about the school for a student
951
+ #
910
952
  # Returns the primary school for a student
911
953
  # @param id
912
954
  # @param [Hash] opts the optional parameters
@@ -916,7 +958,7 @@ module Clever
916
958
  return data
917
959
  end
918
960
 
919
- # Retrieves information about the school for a student
961
+ #
920
962
  # Returns the primary school for a student
921
963
  # @param id
922
964
  # @param [Hash] opts the optional parameters
@@ -957,7 +999,7 @@ module Clever
957
999
  return data, status_code, headers
958
1000
  end
959
1001
 
960
- # Retrieves information about the school for a teacher
1002
+ #
961
1003
  # Retrieves school info for a teacher.
962
1004
  # @param id
963
1005
  # @param [Hash] opts the optional parameters
@@ -967,7 +1009,7 @@ module Clever
967
1009
  return data
968
1010
  end
969
1011
 
970
- # Retrieves information about the school for a teacher
1012
+ #
971
1013
  # Retrieves school info for a teacher.
972
1014
  # @param id
973
1015
  # @param [Hash] opts the optional parameters
@@ -1008,7 +1050,7 @@ module Clever
1008
1050
  return data, status_code, headers
1009
1051
  end
1010
1052
 
1011
- # Gets a list of schools you have access to.
1053
+ #
1012
1054
  # Returns a list of schools
1013
1055
  # @param [Hash] opts the optional parameters
1014
1056
  # @option opts [Integer] :limit
@@ -1020,7 +1062,7 @@ module Clever
1020
1062
  return data
1021
1063
  end
1022
1064
 
1023
- # Gets a list of schools you have access to.
1065
+ #
1024
1066
  # Returns a list of schools
1025
1067
  # @param [Hash] opts the optional parameters
1026
1068
  # @option opts [Integer] :limit
@@ -1064,7 +1106,7 @@ module Clever
1064
1106
  return data, status_code, headers
1065
1107
  end
1066
1108
 
1067
- # Retrieves all schools for a school admin.
1109
+ #
1068
1110
  # Returns the schools for a school admin
1069
1111
  # @param id
1070
1112
  # @param [Hash] opts the optional parameters
@@ -1077,7 +1119,7 @@ module Clever
1077
1119
  return data
1078
1120
  end
1079
1121
 
1080
- # Retrieves all schools for a school admin.
1122
+ #
1081
1123
  # Returns the schools for a school admin
1082
1124
  # @param id
1083
1125
  # @param [Hash] opts the optional parameters
@@ -1124,7 +1166,7 @@ module Clever
1124
1166
  return data, status_code, headers
1125
1167
  end
1126
1168
 
1127
- # Get only a specific section's information.
1169
+ #
1128
1170
  # Returns a specific section
1129
1171
  # @param id
1130
1172
  # @param [Hash] opts the optional parameters
@@ -1134,7 +1176,7 @@ module Clever
1134
1176
  return data
1135
1177
  end
1136
1178
 
1137
- # Get only a specific section&#39;s information.
1179
+ #
1138
1180
  # Returns a specific section
1139
1181
  # @param id
1140
1182
  # @param [Hash] opts the optional parameters
@@ -1175,7 +1217,7 @@ module Clever
1175
1217
  return data, status_code, headers
1176
1218
  end
1177
1219
 
1178
- # Gets a list of sections you have access to.
1220
+ #
1179
1221
  # Returns a list of sections
1180
1222
  # @param [Hash] opts the optional parameters
1181
1223
  # @option opts [Integer] :limit
@@ -1187,7 +1229,7 @@ module Clever
1187
1229
  return data
1188
1230
  end
1189
1231
 
1190
- # Gets a list of sections you have access to.
1232
+ #
1191
1233
  # Returns a list of sections
1192
1234
  # @param [Hash] opts the optional parameters
1193
1235
  # @option opts [Integer] :limit
@@ -1231,7 +1273,7 @@ module Clever
1231
1273
  return data, status_code, headers
1232
1274
  end
1233
1275
 
1234
- # Retrieves a list of all sections for a specific school.
1276
+ #
1235
1277
  # Returns the sections for a school
1236
1278
  # @param id
1237
1279
  # @param [Hash] opts the optional parameters
@@ -1244,7 +1286,7 @@ module Clever
1244
1286
  return data
1245
1287
  end
1246
1288
 
1247
- # Retrieves a list of all sections for a specific school.
1289
+ #
1248
1290
  # Returns the sections for a school
1249
1291
  # @param id
1250
1292
  # @param [Hash] opts the optional parameters
@@ -1291,7 +1333,7 @@ module Clever
1291
1333
  return data, status_code, headers
1292
1334
  end
1293
1335
 
1294
- # Retrieves a list of all sections for a student.
1336
+ #
1295
1337
  # Returns the sections for a student
1296
1338
  # @param id
1297
1339
  # @param [Hash] opts the optional parameters
@@ -1304,7 +1346,7 @@ module Clever
1304
1346
  return data
1305
1347
  end
1306
1348
 
1307
- # Retrieves a list of all sections for a student.
1349
+ #
1308
1350
  # Returns the sections for a student
1309
1351
  # @param id
1310
1352
  # @param [Hash] opts the optional parameters
@@ -1351,7 +1393,7 @@ module Clever
1351
1393
  return data, status_code, headers
1352
1394
  end
1353
1395
 
1354
- # Retrieves a list of all sections for a teacher.
1396
+ #
1355
1397
  # Returns the sections for a teacher
1356
1398
  # @param id
1357
1399
  # @param [Hash] opts the optional parameters
@@ -1364,7 +1406,7 @@ module Clever
1364
1406
  return data
1365
1407
  end
1366
1408
 
1367
- # Retrieves a list of all sections for a teacher.
1409
+ #
1368
1410
  # Returns the sections for a teacher
1369
1411
  # @param id
1370
1412
  # @param [Hash] opts the optional parameters
@@ -1411,7 +1453,7 @@ module Clever
1411
1453
  return data, status_code, headers
1412
1454
  end
1413
1455
 
1414
- # Get only a specific student's information.
1456
+ #
1415
1457
  # Returns a specific student
1416
1458
  # @param id
1417
1459
  # @param [Hash] opts the optional parameters
@@ -1421,7 +1463,7 @@ module Clever
1421
1463
  return data
1422
1464
  end
1423
1465
 
1424
- # Get only a specific student&#39;s information.
1466
+ #
1425
1467
  # Returns a specific student
1426
1468
  # @param id
1427
1469
  # @param [Hash] opts the optional parameters
@@ -1462,7 +1504,7 @@ module Clever
1462
1504
  return data, status_code, headers
1463
1505
  end
1464
1506
 
1465
- # Retrieves the student for a contact.
1507
+ #
1466
1508
  # Returns the student for a student contact
1467
1509
  # @param id
1468
1510
  # @param [Hash] opts the optional parameters
@@ -1472,7 +1514,7 @@ module Clever
1472
1514
  return data
1473
1515
  end
1474
1516
 
1475
- # Retrieves the student for a contact.
1517
+ #
1476
1518
  # Returns the student for a student contact
1477
1519
  # @param id
1478
1520
  # @param [Hash] opts the optional parameters
@@ -1513,7 +1555,7 @@ module Clever
1513
1555
  return data, status_code, headers
1514
1556
  end
1515
1557
 
1516
- # Gets a list of students you have access to.
1558
+ #
1517
1559
  # Returns a list of students
1518
1560
  # @param [Hash] opts the optional parameters
1519
1561
  # @option opts [Integer] :limit
@@ -1525,7 +1567,7 @@ module Clever
1525
1567
  return data
1526
1568
  end
1527
1569
 
1528
- # Gets a list of students you have access to.
1570
+ #
1529
1571
  # Returns a list of students
1530
1572
  # @param [Hash] opts the optional parameters
1531
1573
  # @option opts [Integer] :limit
@@ -1569,7 +1611,7 @@ module Clever
1569
1611
  return data, status_code, headers
1570
1612
  end
1571
1613
 
1572
- # Retrieves a list of all students for a specific school.
1614
+ #
1573
1615
  # Returns the students for a school
1574
1616
  # @param id
1575
1617
  # @param [Hash] opts the optional parameters
@@ -1582,7 +1624,7 @@ module Clever
1582
1624
  return data
1583
1625
  end
1584
1626
 
1585
- # Retrieves a list of all students for a specific school.
1627
+ #
1586
1628
  # Returns the students for a school
1587
1629
  # @param id
1588
1630
  # @param [Hash] opts the optional parameters
@@ -1629,7 +1671,7 @@ module Clever
1629
1671
  return data, status_code, headers
1630
1672
  end
1631
1673
 
1632
- # Retrieves a list of all the section's students.
1674
+ #
1633
1675
  # Returns the students for a section
1634
1676
  # @param id
1635
1677
  # @param [Hash] opts the optional parameters
@@ -1642,7 +1684,7 @@ module Clever
1642
1684
  return data
1643
1685
  end
1644
1686
 
1645
- # Retrieves a list of all the section&#39;s students.
1687
+ #
1646
1688
  # Returns the students for a section
1647
1689
  # @param id
1648
1690
  # @param [Hash] opts the optional parameters
@@ -1689,7 +1731,7 @@ module Clever
1689
1731
  return data, status_code, headers
1690
1732
  end
1691
1733
 
1692
- # Retrieves all students that a teacher has in their sections.
1734
+ #
1693
1735
  # Returns the students for a teacher
1694
1736
  # @param id
1695
1737
  # @param [Hash] opts the optional parameters
@@ -1702,7 +1744,7 @@ module Clever
1702
1744
  return data
1703
1745
  end
1704
1746
 
1705
- # Retrieves all students that a teacher has in their sections.
1747
+ #
1706
1748
  # Returns the students for a teacher
1707
1749
  # @param id
1708
1750
  # @param [Hash] opts the optional parameters
@@ -1749,7 +1791,7 @@ module Clever
1749
1791
  return data, status_code, headers
1750
1792
  end
1751
1793
 
1752
- # Get only a specific teacher's information.
1794
+ #
1753
1795
  # Returns a specific teacher
1754
1796
  # @param id
1755
1797
  # @param [Hash] opts the optional parameters
@@ -1759,7 +1801,7 @@ module Clever
1759
1801
  return data
1760
1802
  end
1761
1803
 
1762
- # Get only a specific teacher&#39;s information.
1804
+ #
1763
1805
  # Returns a specific teacher
1764
1806
  # @param id
1765
1807
  # @param [Hash] opts the optional parameters
@@ -1800,7 +1842,7 @@ module Clever
1800
1842
  return data, status_code, headers
1801
1843
  end
1802
1844
 
1803
- # Retrieves information about the primary teacher of a section.
1845
+ #
1804
1846
  # Returns the primary teacher for a section
1805
1847
  # @param id
1806
1848
  # @param [Hash] opts the optional parameters
@@ -1810,7 +1852,7 @@ module Clever
1810
1852
  return data
1811
1853
  end
1812
1854
 
1813
- # Retrieves information about the primary teacher of a section.
1855
+ #
1814
1856
  # Returns the primary teacher for a section
1815
1857
  # @param id
1816
1858
  # @param [Hash] opts the optional parameters
@@ -1851,7 +1893,7 @@ module Clever
1851
1893
  return data, status_code, headers
1852
1894
  end
1853
1895
 
1854
- # Gets a list of teachers you have access to.
1896
+ #
1855
1897
  # Returns a list of teachers
1856
1898
  # @param [Hash] opts the optional parameters
1857
1899
  # @option opts [Integer] :limit
@@ -1863,7 +1905,7 @@ module Clever
1863
1905
  return data
1864
1906
  end
1865
1907
 
1866
- # Gets a list of teachers you have access to.
1908
+ #
1867
1909
  # Returns a list of teachers
1868
1910
  # @param [Hash] opts the optional parameters
1869
1911
  # @option opts [Integer] :limit
@@ -1907,7 +1949,7 @@ module Clever
1907
1949
  return data, status_code, headers
1908
1950
  end
1909
1951
 
1910
- # Retrieves a list of all teachers for a specific school.
1952
+ #
1911
1953
  # Returns the teachers for a school
1912
1954
  # @param id
1913
1955
  # @param [Hash] opts the optional parameters
@@ -1920,7 +1962,7 @@ module Clever
1920
1962
  return data
1921
1963
  end
1922
1964
 
1923
- # Retrieves a list of all teachers for a specific school.
1965
+ #
1924
1966
  # Returns the teachers for a school
1925
1967
  # @param id
1926
1968
  # @param [Hash] opts the optional parameters
@@ -1967,7 +2009,7 @@ module Clever
1967
2009
  return data, status_code, headers
1968
2010
  end
1969
2011
 
1970
- # Retrieves a list of all the section's teachers.
2012
+ #
1971
2013
  # Returns the teachers for a section
1972
2014
  # @param id
1973
2015
  # @param [Hash] opts the optional parameters
@@ -1980,7 +2022,7 @@ module Clever
1980
2022
  return data
1981
2023
  end
1982
2024
 
1983
- # Retrieves a list of all the section&#39;s teachers.
2025
+ #
1984
2026
  # Returns the teachers for a section
1985
2027
  # @param id
1986
2028
  # @param [Hash] opts the optional parameters
@@ -2027,7 +2069,7 @@ module Clever
2027
2069
  return data, status_code, headers
2028
2070
  end
2029
2071
 
2030
- # Retrieves all teachers for a student.
2072
+ #
2031
2073
  # Returns the teachers for a student
2032
2074
  # @param id
2033
2075
  # @param [Hash] opts the optional parameters
@@ -2040,7 +2082,7 @@ module Clever
2040
2082
  return data
2041
2083
  end
2042
2084
 
2043
- # Retrieves all teachers for a student.
2085
+ #
2044
2086
  # Returns the teachers for a student
2045
2087
  # @param id
2046
2088
  # @param [Hash] opts the optional parameters