google-apis-classroom_v1 0.9.0 → 0.13.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5be0aea3f892a04f0b7bceddae7642b0c66c4b054e866864d7861a2bd0765a05
4
- data.tar.gz: e6e56e760d2a1146fbe270d73b5075986bad8c97257de819a783e8ec4683ff30
3
+ metadata.gz: ae614f18bab8324ca24702815981a1114dcc38b358ff5234610116416f898c45
4
+ data.tar.gz: 07d6cbf4b99a041f0718c1efffc61211965c953e127dbacd27319b4490a4a11a
5
5
  SHA512:
6
- metadata.gz: fb0edbe418d09fdfc5d45633b067a0bd6c255d43c78d81b6f77cbf6c32a810b97033abc58cf6378180bfd082a566b9ad5388253cf2c139cecc0f4d69abbd240b
7
- data.tar.gz: 6842f2ef57e945ca1a0f356d55a06be14e406139691426eb4a40e7f535db4debe49a700bc68705e6c4ae7af6818104f8e2910e189a716bd4a375108e0f4e24e4
6
+ metadata.gz: e3d20b19a2d22a29c25984cab9345f6c9139db3debc7572353941853c842f7e887784242f89f3077b1052f23a525ffca0bd67d2d6783b5f79ee8cdc8fa35d5b3
7
+ data.tar.gz: 26795c45d77bbce87ef47bc301def0760722645abe582375f51643b2d5941c97528b1b28a3ee4bd489dbb60aa3f8b1de30ecbe667f0d79bfd0186d485194ed94
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-classroom_v1
2
2
 
3
+ ### v0.13.0 (2022-02-15)
4
+
5
+ * Regenerated from discovery document revision 20220209
6
+
7
+ ### v0.12.0 (2022-02-08)
8
+
9
+ * Regenerated from discovery document revision 20220202
10
+
11
+ ### v0.11.0 (2022-02-04)
12
+
13
+ * Regenerated from discovery document revision 20220131
14
+ * Regenerated using generator version 0.4.1
15
+
16
+ ### v0.10.0 (2021-12-14)
17
+
18
+ * Unspecified changes
19
+
3
20
  ### v0.9.0 (2021-11-03)
4
21
 
5
22
  * Regenerated from discovery document revision 20211029
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/classroom_v1"
51
51
  client = Google::Apis::ClassroomV1::ClassroomService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -274,6 +274,12 @@ module Google
274
274
  # @return [String]
275
275
  attr_accessor :enrollment_code
276
276
 
277
+ # The gradebook settings for a course. See the [help center article](https://
278
+ # support.google.com/edu/classroom/answer/9184995) for details.
279
+ # Corresponds to the JSON property `gradebookSettings`
280
+ # @return [Google::Apis::ClassroomV1::GradebookSettings]
281
+ attr_accessor :gradebook_settings
282
+
277
283
  # Whether or not guardian notifications are enabled for this course. Read-only.
278
284
  # Corresponds to the JSON property `guardiansEnabled`
279
285
  # @return [Boolean]
@@ -350,6 +356,7 @@ module Google
350
356
  @description = args[:description] if args.key?(:description)
351
357
  @description_heading = args[:description_heading] if args.key?(:description_heading)
352
358
  @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code)
359
+ @gradebook_settings = args[:gradebook_settings] if args.key?(:gradebook_settings)
353
360
  @guardians_enabled = args[:guardians_enabled] if args.key?(:guardians_enabled)
354
361
  @id = args[:id] if args.key?(:id)
355
362
  @name = args[:name] if args.key?(:name)
@@ -530,10 +537,10 @@ module Google
530
537
  # day and time zone are either specified elsewhere or are insignificant. The
531
538
  # date is relative to the Gregorian Calendar. This can represent one of the
532
539
  # following: * A full date, with non-zero year, month, and day values * A month
533
- # and day value, with a zero year, such as an anniversary * A year on its own,
534
- # with zero month and day values * A year and month value, with a zero day, such
535
- # as a credit card expiration date Related types are google.type.TimeOfDay and `
536
- # google.protobuf.Timestamp`.
540
+ # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
541
+ # zero month and a zero day * A year and month, with a zero day (e.g., a credit
542
+ # card expiration date) Related types: * google.type.TimeOfDay * google.type.
543
+ # DateTime * google.protobuf.Timestamp
537
544
  # Corresponds to the JSON property `dueDate`
538
545
  # @return [Google::Apis::ClassroomV1::Date]
539
546
  attr_accessor :due_date
@@ -545,6 +552,14 @@ module Google
545
552
  # @return [Google::Apis::ClassroomV1::TimeOfDay]
546
553
  attr_accessor :due_time
547
554
 
555
+ # Details for a grade category in a course. Coursework may have zero or one
556
+ # grade category, and the category may be used in computing the overall grade.
557
+ # See the [help center article](https://support.google.com/edu/classroom/answer/
558
+ # 9184995) for details.
559
+ # Corresponds to the JSON property `gradeCategory`
560
+ # @return [Google::Apis::ClassroomV1::GradeCategory]
561
+ attr_accessor :grade_category
562
+
548
563
  # Classroom-assigned identifier of this course work, unique per course. Read-
549
564
  # only.
550
565
  # Corresponds to the JSON property `id`
@@ -628,6 +643,7 @@ module Google
628
643
  @description = args[:description] if args.key?(:description)
629
644
  @due_date = args[:due_date] if args.key?(:due_date)
630
645
  @due_time = args[:due_time] if args.key?(:due_time)
646
+ @grade_category = args[:grade_category] if args.key?(:grade_category)
631
647
  @id = args[:id] if args.key?(:id)
632
648
  @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options)
633
649
  @materials = args[:materials] if args.key?(:materials)
@@ -772,10 +788,10 @@ module Google
772
788
  # day and time zone are either specified elsewhere or are insignificant. The
773
789
  # date is relative to the Gregorian Calendar. This can represent one of the
774
790
  # following: * A full date, with non-zero year, month, and day values * A month
775
- # and day value, with a zero year, such as an anniversary * A year on its own,
776
- # with zero month and day values * A year and month value, with a zero day, such
777
- # as a credit card expiration date Related types are google.type.TimeOfDay and `
778
- # google.protobuf.Timestamp`.
791
+ # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
792
+ # zero month and a zero day * A year and month, with a zero day (e.g., a credit
793
+ # card expiration date) Related types: * google.type.TimeOfDay * google.type.
794
+ # DateTime * google.protobuf.Timestamp
779
795
  class Date
780
796
  include Google::Apis::Core::Hashable
781
797
 
@@ -983,6 +999,50 @@ module Google
983
999
  end
984
1000
  end
985
1001
 
1002
+ # Details for a grade category in a course. Coursework may have zero or one
1003
+ # grade category, and the category may be used in computing the overall grade.
1004
+ # See the [help center article](https://support.google.com/edu/classroom/answer/
1005
+ # 9184995) for details.
1006
+ class GradeCategory
1007
+ include Google::Apis::Core::Hashable
1008
+
1009
+ # Default value of denominator. Only applicable when grade calculation type is
1010
+ # TOTAL_POINTS.
1011
+ # Corresponds to the JSON property `defaultGradeDenominator`
1012
+ # @return [Fixnum]
1013
+ attr_accessor :default_grade_denominator
1014
+
1015
+ # ID of the grade category.
1016
+ # Corresponds to the JSON property `id`
1017
+ # @return [String]
1018
+ attr_accessor :id
1019
+
1020
+ # Name of the grade category.
1021
+ # Corresponds to the JSON property `name`
1022
+ # @return [String]
1023
+ attr_accessor :name
1024
+
1025
+ # The weight of the category average as part of overall average. A weight of 12.
1026
+ # 34% is represented as 123400 (100% is 1,000,000). The last two digits should
1027
+ # always be zero since we use two decimal precision. Only applicable when grade
1028
+ # calculation type is WEIGHTED_CATEGORIES.
1029
+ # Corresponds to the JSON property `weight`
1030
+ # @return [Fixnum]
1031
+ attr_accessor :weight
1032
+
1033
+ def initialize(**args)
1034
+ update!(**args)
1035
+ end
1036
+
1037
+ # Update properties of this object
1038
+ def update!(**args)
1039
+ @default_grade_denominator = args[:default_grade_denominator] if args.key?(:default_grade_denominator)
1040
+ @id = args[:id] if args.key?(:id)
1041
+ @name = args[:name] if args.key?(:name)
1042
+ @weight = args[:weight] if args.key?(:weight)
1043
+ end
1044
+ end
1045
+
986
1046
  # The history of each grade on this submission.
987
1047
  class GradeHistory
988
1048
  include Google::Apis::Core::Hashable
@@ -1026,6 +1086,38 @@ module Google
1026
1086
  end
1027
1087
  end
1028
1088
 
1089
+ # The gradebook settings for a course. See the [help center article](https://
1090
+ # support.google.com/edu/classroom/answer/9184995) for details.
1091
+ class GradebookSettings
1092
+ include Google::Apis::Core::Hashable
1093
+
1094
+ # Indicates how the overall grade is calculated.
1095
+ # Corresponds to the JSON property `calculationType`
1096
+ # @return [String]
1097
+ attr_accessor :calculation_type
1098
+
1099
+ # Indicates who can see the overall grade..
1100
+ # Corresponds to the JSON property `displaySetting`
1101
+ # @return [String]
1102
+ attr_accessor :display_setting
1103
+
1104
+ # Grade categories that are available for coursework in the course.
1105
+ # Corresponds to the JSON property `gradeCategories`
1106
+ # @return [Array<Google::Apis::ClassroomV1::GradeCategory>]
1107
+ attr_accessor :grade_categories
1108
+
1109
+ def initialize(**args)
1110
+ update!(**args)
1111
+ end
1112
+
1113
+ # Update properties of this object
1114
+ def update!(**args)
1115
+ @calculation_type = args[:calculation_type] if args.key?(:calculation_type)
1116
+ @display_setting = args[:display_setting] if args.key?(:display_setting)
1117
+ @grade_categories = args[:grade_categories] if args.key?(:grade_categories)
1118
+ end
1119
+ end
1120
+
1029
1121
  # Association between a student and a guardian of that student. The guardian may
1030
1122
  # receive information about the student's course work.
1031
1123
  class Guardian
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module ClassroomV1
18
18
  # Version of the google-apis-classroom_v1 gem
19
- GEM_VERSION = "0.9.0"
19
+ GEM_VERSION = "0.13.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211029"
25
+ REVISION = "20220209"
26
26
  end
27
27
  end
28
28
  end
@@ -142,12 +142,24 @@ module Google
142
142
  include Google::Apis::Core::JsonObjectSupport
143
143
  end
144
144
 
145
+ class GradeCategory
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
145
151
  class GradeHistory
146
152
  class Representation < Google::Apis::Core::JsonRepresentation; end
147
153
 
148
154
  include Google::Apis::Core::JsonObjectSupport
149
155
  end
150
156
 
157
+ class GradebookSettings
158
+ class Representation < Google::Apis::Core::JsonRepresentation; end
159
+
160
+ include Google::Apis::Core::JsonObjectSupport
161
+ end
162
+
151
163
  class Guardian
152
164
  class Representation < Google::Apis::Core::JsonRepresentation; end
153
165
 
@@ -458,6 +470,8 @@ module Google
458
470
  property :description, as: 'description'
459
471
  property :description_heading, as: 'descriptionHeading'
460
472
  property :enrollment_code, as: 'enrollmentCode'
473
+ property :gradebook_settings, as: 'gradebookSettings', class: Google::Apis::ClassroomV1::GradebookSettings, decorator: Google::Apis::ClassroomV1::GradebookSettings::Representation
474
+
461
475
  property :guardians_enabled, as: 'guardiansEnabled'
462
476
  property :id, as: 'id'
463
477
  property :name, as: 'name'
@@ -524,6 +538,8 @@ module Google
524
538
 
525
539
  property :due_time, as: 'dueTime', class: Google::Apis::ClassroomV1::TimeOfDay, decorator: Google::Apis::ClassroomV1::TimeOfDay::Representation
526
540
 
541
+ property :grade_category, as: 'gradeCategory', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
542
+
527
543
  property :id, as: 'id'
528
544
  property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation
529
545
 
@@ -633,6 +649,16 @@ module Google
633
649
  end
634
650
  end
635
651
 
652
+ class GradeCategory
653
+ # @private
654
+ class Representation < Google::Apis::Core::JsonRepresentation
655
+ property :default_grade_denominator, as: 'defaultGradeDenominator'
656
+ property :id, as: 'id'
657
+ property :name, as: 'name'
658
+ property :weight, as: 'weight'
659
+ end
660
+ end
661
+
636
662
  class GradeHistory
637
663
  # @private
638
664
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -644,6 +670,16 @@ module Google
644
670
  end
645
671
  end
646
672
 
673
+ class GradebookSettings
674
+ # @private
675
+ class Representation < Google::Apis::Core::JsonRepresentation
676
+ property :calculation_type, as: 'calculationType'
677
+ property :display_setting, as: 'displaySetting'
678
+ collection :grade_categories, as: 'gradeCategories', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
679
+
680
+ end
681
+ end
682
+
647
683
  class Guardian
648
684
  # @private
649
685
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -50,7 +50,9 @@ module Google
50
50
  end
51
51
 
52
52
  # Creates a course. The user specified in `ownerId` is the owner of the created
53
- # course and added as a teacher. This method returns the following error codes: *
53
+ # course and added as a teacher. A non-admin requesting user can only create a
54
+ # course with themselves as the owner. Domain admins can create courses owned by
55
+ # any user within their domain. This method returns the following error codes: *
54
56
  # `PERMISSION_DENIED` if the requesting user is not permitted to create courses
55
57
  # or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user.
56
58
  # * `FAILED_PRECONDITION` if the course owner's account is disabled or for the
@@ -1577,12 +1579,15 @@ module Google
1577
1579
  execute_or_queue_command(command, &block)
1578
1580
  end
1579
1581
 
1580
- # Adds a user as a student of a course. This method returns the following error
1581
- # codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create
1582
- # students in this course or for access errors. * `NOT_FOUND` if the requested
1583
- # course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
1584
- # account is disabled, for the following request errors: *
1585
- # CourseMemberLimitReached * CourseNotModifiable *
1582
+ # Adds a user as a student of a course. Domain administrators are permitted to [
1583
+ # directly add](https://developers.google.com/classroom/guides/manage-users)
1584
+ # users within their domain as students to courses within their domain. Students
1585
+ # are permitted to add themselves to a course using an enrollment code. This
1586
+ # method returns the following error codes: * `PERMISSION_DENIED` if the
1587
+ # requesting user is not permitted to create students in this course or for
1588
+ # access errors. * `NOT_FOUND` if the requested course ID does not exist. * `
1589
+ # FAILED_PRECONDITION` if the requested user's account is disabled, for the
1590
+ # following request errors: * CourseMemberLimitReached * CourseNotModifiable *
1586
1591
  # UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
1587
1592
  # student or teacher in the course.
1588
1593
  # @param [String] course_id
@@ -1743,11 +1748,14 @@ module Google
1743
1748
  execute_or_queue_command(command, &block)
1744
1749
  end
1745
1750
 
1746
- # Creates a teacher of a course. This method returns the following error codes: *
1747
- # `PERMISSION_DENIED` if the requesting user is not permitted to create
1748
- # teachers in this course or for access errors. * `NOT_FOUND` if the requested
1749
- # course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
1750
- # account is disabled, for the following request errors: *
1751
+ # Creates a teacher of a course. Domain administrators are permitted to [
1752
+ # directly add](https://developers.google.com/classroom/guides/manage-users)
1753
+ # users within their domain as teachers to courses within their domain. Non-
1754
+ # admin users should send an Invitation instead. This method returns the
1755
+ # following error codes: * `PERMISSION_DENIED` if the requesting user is not
1756
+ # permitted to create teachers in this course or for access errors. * `NOT_FOUND`
1757
+ # if the requested course ID does not exist. * `FAILED_PRECONDITION` if the
1758
+ # requested user's account is disabled, for the following request errors: *
1751
1759
  # CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached *
1752
1760
  # UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
1753
1761
  # teacher or student in the course.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-classroom_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-08 00:00:00.000000000 Z
11
+ date: 2022-02-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.9.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.13.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Classroom API V1