google-apis-classroom_v1 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0196637e7f5dd7b1ff744e02bc0eee22040c0301280dfdf296673a7e4fb1ac6c'
-  data.tar.gz: b069f0aaac459c8234251ec322ce1001dbc872c45c3610c266b862550f2a54fd
+  metadata.gz: cddce3312cae108d49d03c6827184fd6a1ebcde12390418ae04fdaa5ce93ca01
+  data.tar.gz: 56ab6496be55f2ae56096e7e01e0013b91d2a9835a0b6f1c6311d8ee60696f5c
 SHA512:
-  metadata.gz: 9e74e37d614296f68025ae81d4301f8128a414b9e8d0c1eb8d6d059378c7362ad9437cfaed898c972d2168835e75de26c5ee3e49821f3dee774d82caab4e927e
-  data.tar.gz: 93042877d9f1a3ee654bf268fa7e817066566b468bcd6c2516bfd5a83b2fa9d742ac2da94f86f6225b300d8a0dcfb63b3709bb32fc2f0392973d32ad4090069a
+  metadata.gz: a8a644e92c775fdefd474ea579b9a446f9f2b21242e024190071029b72b1f72c0b50c908c8a062ee47915690a688dd23407057ac992d699d0ebf7a9947a6da1f
+  data.tar.gz: f8f8d486efef36b4d2f658ab9a804992f23fc5ae31e70f525991b88198e1152ee12f7c27183343ba70fcf11718cb7c8075ec9d66acb23556e01f405f0dea4ba7

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-classroom_v1
 
+### v0.12.0 (2022-02-08)
+
+* Regenerated from discovery document revision 20220202
+
+### v0.11.0 (2022-02-04)
+
+* Regenerated from discovery document revision 20220131
+* Regenerated using generator version 0.4.1
+
+### v0.10.0 (2021-12-14)
+
+* Unspecified changes
+
+### v0.9.0 (2021-11-03)
+
+* Regenerated from discovery document revision 20211029
+
 ### v0.8.0 (2021-10-20)
 
 * Unspecified changes

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/classroom_v1"
 client = Google::Apis::ClassroomV1::ClassroomService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

data/lib/google/apis/classroom_v1/classes.rb

@@ -274,6 +274,12 @@ module Google
         # @return [String]
         attr_accessor :enrollment_code
       
+        # The gradebook settings for a course. See the [help center article](https://
+        # support.google.com/edu/classroom/answer/9184995) for details.
+        # Corresponds to the JSON property `gradebookSettings`
+        # @return [Google::Apis::ClassroomV1::GradebookSettings]
+        attr_accessor :gradebook_settings
+      
         # Whether or not guardian notifications are enabled for this course. Read-only.
         # Corresponds to the JSON property `guardiansEnabled`
         # @return [Boolean]
@@ -350,6 +356,7 @@ module Google
           @description = args[:description] if args.key?(:description)
           @description_heading = args[:description_heading] if args.key?(:description_heading)
           @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code)
+          @gradebook_settings = args[:gradebook_settings] if args.key?(:gradebook_settings)
           @guardians_enabled = args[:guardians_enabled] if args.key?(:guardians_enabled)
           @id = args[:id] if args.key?(:id)
           @name = args[:name] if args.key?(:name)
@@ -530,10 +537,10 @@ module Google
         # day and time zone are either specified elsewhere or are insignificant. The
         # date is relative to the Gregorian Calendar. This can represent one of the
         # following: * A full date, with non-zero year, month, and day values * A month
-        # and day value, with a zero year, such as an anniversary * A year on its own,
-        # with zero month and day values * A year and month value, with a zero day, such
-        # as a credit card expiration date Related types are google.type.TimeOfDay and `
-        # google.protobuf.Timestamp`.
+        # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
+        # zero month and a zero day * A year and month, with a zero day (e.g., a credit
+        # card expiration date) Related types: * google.type.TimeOfDay * google.type.
+        # DateTime * google.protobuf.Timestamp
         # Corresponds to the JSON property `dueDate`
         # @return [Google::Apis::ClassroomV1::Date]
         attr_accessor :due_date
@@ -545,6 +552,14 @@ module Google
         # @return [Google::Apis::ClassroomV1::TimeOfDay]
         attr_accessor :due_time
       
+        # Details for a grade category in a course. Coursework may have zero or one
+        # grade category, and the category may be used in computing the overall grade.
+        # See the [help center article](https://support.google.com/edu/classroom/answer/
+        # 9184995) for details.
+        # Corresponds to the JSON property `gradeCategory`
+        # @return [Google::Apis::ClassroomV1::GradeCategory]
+        attr_accessor :grade_category
+      
         # Classroom-assigned identifier of this course work, unique per course. Read-
         # only.
         # Corresponds to the JSON property `id`
@@ -628,6 +643,7 @@ module Google
           @description = args[:description] if args.key?(:description)
           @due_date = args[:due_date] if args.key?(:due_date)
           @due_time = args[:due_time] if args.key?(:due_time)
+          @grade_category = args[:grade_category] if args.key?(:grade_category)
           @id = args[:id] if args.key?(:id)
           @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options)
           @materials = args[:materials] if args.key?(:materials)
@@ -772,10 +788,10 @@ module Google
       # day and time zone are either specified elsewhere or are insignificant. The
       # date is relative to the Gregorian Calendar. This can represent one of the
       # following: * A full date, with non-zero year, month, and day values * A month
-      # and day value, with a zero year, such as an anniversary * A year on its own,
-      # with zero month and day values * A year and month value, with a zero day, such
-      # as a credit card expiration date Related types are google.type.TimeOfDay and `
-      # google.protobuf.Timestamp`.
+      # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
+      # zero month and a zero day * A year and month, with a zero day (e.g., a credit
+      # card expiration date) Related types: * google.type.TimeOfDay * google.type.
+      # DateTime * google.protobuf.Timestamp
       class Date
         include Google::Apis::Core::Hashable
       
@@ -983,6 +999,50 @@ module Google
         end
       end
       
+      # Details for a grade category in a course. Coursework may have zero or one
+      # grade category, and the category may be used in computing the overall grade.
+      # See the [help center article](https://support.google.com/edu/classroom/answer/
+      # 9184995) for details.
+      class GradeCategory
+        include Google::Apis::Core::Hashable
+      
+        # Default value of denominator. Only applicable when grade calculation type is
+        # TOTAL_POINTS.
+        # Corresponds to the JSON property `defaultGradeDenominator`
+        # @return [Fixnum]
+        attr_accessor :default_grade_denominator
+      
+        # ID of the grade category.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # Name of the grade category.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The weight of the category average as part of overall average. A weight of 12.
+        # 34% is represented as 123400 (100% is 1,000,000). The last two digits should
+        # always be zero since we use two decimal precision. Only applicable when grade
+        # calculation type is WEIGHTED_CATEGORIES.
+        # Corresponds to the JSON property `weight`
+        # @return [Fixnum]
+        attr_accessor :weight
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @default_grade_denominator = args[:default_grade_denominator] if args.key?(:default_grade_denominator)
+          @id = args[:id] if args.key?(:id)
+          @name = args[:name] if args.key?(:name)
+          @weight = args[:weight] if args.key?(:weight)
+        end
+      end
+      
       # The history of each grade on this submission.
       class GradeHistory
         include Google::Apis::Core::Hashable
@@ -1026,6 +1086,38 @@ module Google
         end
       end
       
+      # The gradebook settings for a course. See the [help center article](https://
+      # support.google.com/edu/classroom/answer/9184995) for details.
+      class GradebookSettings
+        include Google::Apis::Core::Hashable
+      
+        # Indicates how the overall grade is calculated.
+        # Corresponds to the JSON property `calculationType`
+        # @return [String]
+        attr_accessor :calculation_type
+      
+        # Indicates who can see the overall grade..
+        # Corresponds to the JSON property `displaySetting`
+        # @return [String]
+        attr_accessor :display_setting
+      
+        # Grade categories that are available for coursework in the course.
+        # Corresponds to the JSON property `gradeCategories`
+        # @return [Array<Google::Apis::ClassroomV1::GradeCategory>]
+        attr_accessor :grade_categories
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @calculation_type = args[:calculation_type] if args.key?(:calculation_type)
+          @display_setting = args[:display_setting] if args.key?(:display_setting)
+          @grade_categories = args[:grade_categories] if args.key?(:grade_categories)
+        end
+      end
+      
       # Association between a student and a guardian of that student. The guardian may
       # receive information about the student's course work.
       class Guardian

data/lib/google/apis/classroom_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module ClassroomV1
       # Version of the google-apis-classroom_v1 gem
-      GEM_VERSION = "0.8.0"
+      GEM_VERSION = "0.12.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.0"
+      GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210827"
+      REVISION = "20220202"
     end
   end
 end

data/lib/google/apis/classroom_v1/representations.rb

@@ -142,12 +142,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GradeCategory
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GradeHistory
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GradebookSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Guardian
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -458,6 +470,8 @@ module Google
           property :description, as: 'description'
           property :description_heading, as: 'descriptionHeading'
           property :enrollment_code, as: 'enrollmentCode'
+          property :gradebook_settings, as: 'gradebookSettings', class: Google::Apis::ClassroomV1::GradebookSettings, decorator: Google::Apis::ClassroomV1::GradebookSettings::Representation
+      
           property :guardians_enabled, as: 'guardiansEnabled'
           property :id, as: 'id'
           property :name, as: 'name'
@@ -524,6 +538,8 @@ module Google
       
           property :due_time, as: 'dueTime', class: Google::Apis::ClassroomV1::TimeOfDay, decorator: Google::Apis::ClassroomV1::TimeOfDay::Representation
       
+          property :grade_category, as: 'gradeCategory', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
+      
           property :id, as: 'id'
           property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation
       
@@ -633,6 +649,16 @@ module Google
         end
       end
       
+      class GradeCategory
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :default_grade_denominator, as: 'defaultGradeDenominator'
+          property :id, as: 'id'
+          property :name, as: 'name'
+          property :weight, as: 'weight'
+        end
+      end
+      
       class GradeHistory
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -644,6 +670,16 @@ module Google
         end
       end
       
+      class GradebookSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :calculation_type, as: 'calculationType'
+          property :display_setting, as: 'displaySetting'
+          collection :grade_categories, as: 'gradeCategories', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
+      
+        end
+      end
+      
       class Guardian
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/classroom_v1/service.rb

@@ -1577,12 +1577,15 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Adds a user as a student of a course. This method returns the following error
-        # codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create
-        # students in this course or for access errors. * `NOT_FOUND` if the requested
-        # course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
-        # account is disabled, for the following request errors: *
-        # CourseMemberLimitReached * CourseNotModifiable *
+        # Adds a user as a student of a course. Domain administrators are permitted to [
+        # directly add](https://developers.google.com/classroom/guides/manage-users)
+        # users within their domain as students to courses within their domain. Students
+        # are permitted to add themselves to a course using an enrollment code. This
+        # method returns the following error codes: * `PERMISSION_DENIED` if the
+        # requesting user is not permitted to create students in this course or for
+        # access errors. * `NOT_FOUND` if the requested course ID does not exist. * `
+        # FAILED_PRECONDITION` if the requested user's account is disabled, for the
+        # following request errors: * CourseMemberLimitReached * CourseNotModifiable *
         # UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
         # student or teacher in the course.
         # @param [String] course_id
@@ -1784,14 +1787,14 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a teacher of a course. This method returns the following error codes: *
-        # `PERMISSION_DENIED` if the requesting user is not permitted to delete
-        # teachers of this course or for access errors. * `NOT_FOUND` if no teacher of
-        # this course has the requested ID or if the course does not exist. * `
-        # FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of
-        # this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner
-        # of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer
-        # has an active owner.
+        # Removes the specified teacher from the specified course. This method returns
+        # the following error codes: * `PERMISSION_DENIED` if the requesting user is not
+        # permitted to delete teachers of this course or for access errors. * `NOT_FOUND`
+        # if no teacher of this course has the requested ID or if the course does not
+        # exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary
+        # teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to
+        # the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no
+        # longer has an active owner.
         # @param [String] course_id
         #   Identifier of the course. This identifier can be either the Classroom-assigned
         #   identifier or an alias.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-classroom_v1
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.8.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.12.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Google Classroom API V1