google-apis-classroom_v1 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939679ebe7b35e2acf30d20828fda005b29a00ed51d45c36b557373a1250c5f2
-  data.tar.gz: 5ac66b1a89b74d725dac2cea1770efb8cfcf7b9c44a342ff4476d3615444a3c0
+  metadata.gz: 8db0766b72466da3c27b6432f2305a036c0275a236792feb7ee6ea4f19b188f6
+  data.tar.gz: 5fef930dbb1456cd695086fb1b39bbb6a04d944f48779bd0c9bb0442c238ca26
 SHA512:
-  metadata.gz: 0b00dcba5bbe6f176d42ee4c8b0f86172f7ffc0702116cb826c884598301f30ec3f62594c514016d156c8062e462a0335477dd5977f4f819f9da44acf152b5c8
-  data.tar.gz: 8c5b23415d005743a6eda16185f0b93abf5ac4608bf7224fcafc9b3f02753207191705d44d71e2796bf1b6a666529611bd2beef6096c3ceffd448c1e44d586f5
+  metadata.gz: 16c140ad754e7dc44cdac9c7b080c9fc9aec8f0f15c592f51e081408dd8fe343f0a9ea15c85d1b10f290d52a45e0d50c267e6d6c744f8fec8d5f2688981908aa
+  data.tar.gz: ddd22200f2eb48e3623ccd5a303179b4ff7fcf9f5b5bd38d7f1b39f851d2a7665548f786900fbc6fc0118dd1fe5ebba9919eb647909e4767cbadbf4e758051ba

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-classroom_v1
 
+### v0.41.0 (2025-04-06)
+
+* Regenerated from discovery document revision 20250331
+
 ### v0.40.0 (2025-03-09)
 
 * Regenerated from discovery document revision 20250303

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

@@ -781,6 +781,15 @@ module Google
         # @return [Google::Apis::ClassroomV1::GradeCategory]
         attr_accessor :grade_category
       
+        # Identifier of the grading period associated with the coursework. * At creation,
+        # if unspecified, the grading period ID will be set based on the `dueDate` (or `
+        # scheduledTime` if no `dueDate` is set). * To indicate no association to any
+        # grading period, set this field to an empty string (""). * If specified, it
+        # must match an existing grading period ID in the course.
+        # Corresponds to the JSON property `gradingPeriodId`
+        # @return [String]
+        attr_accessor :grading_period_id
+      
         # Classroom-assigned identifier of this course work, unique per course. Read-
         # only.
         # Corresponds to the JSON property `id`
@@ -865,6 +874,7 @@ module Google
           @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)
+          @grading_period_id = args[:grading_period_id] if args.key?(:grading_period_id)
           @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)
@@ -1396,6 +1406,93 @@ module Google
         end
       end
       
+      # An individual grading period. Grading periods must not have overlapping date
+      # ranges and must be listed in chronological order. For example, if the end_date
+      # of a grading period is 2024-01-25, then the start_date of the next grading
+      # period must be 2024-01-26 or later. Each grading period must have a unique
+      # title within a course.
+      class GradingPeriod
+        include Google::Apis::Core::Hashable
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # 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, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `endDate`
+        # @return [Google::Apis::ClassroomV1::Date]
+        attr_accessor :end_date
+      
+        # Output only. System generated grading period ID. Read-only.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # 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, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `startDate`
+        # @return [Google::Apis::ClassroomV1::Date]
+        attr_accessor :start_date
+      
+        # Required. Title of the grading period. For example, “Semester 1”.
+        # Corresponds to the JSON property `title`
+        # @return [String]
+        attr_accessor :title
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_date = args[:end_date] if args.key?(:end_date)
+          @id = args[:id] if args.key?(:id)
+          @start_date = args[:start_date] if args.key?(:start_date)
+          @title = args[:title] if args.key?(:title)
+        end
+      end
+      
+      # Grading period settings that include all the individual grading periods in a
+      # course.
+      class GradingPeriodSettings
+        include Google::Apis::Core::Hashable
+      
+        # Supports toggling the application of grading periods on existing stream items.
+        # Once set, this value is persisted meaning that it does not need to be set in
+        # every request to update `GradingPeriodSettings`. If not previously set, the
+        # default is False.
+        # Corresponds to the JSON property `applyToExistingCoursework`
+        # @return [Boolean]
+        attr_accessor :apply_to_existing_coursework
+        alias_method :apply_to_existing_coursework?, :apply_to_existing_coursework
+      
+        # The list of grading periods in a specific course. Grading periods must not
+        # have overlapping date ranges and must be listed in chronological order. Each
+        # grading period must have a unique title within a course.
+        # Corresponds to the JSON property `gradingPeriods`
+        # @return [Array<Google::Apis::ClassroomV1::GradingPeriod>]
+        attr_accessor :grading_periods
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @apply_to_existing_coursework = args[:apply_to_existing_coursework] if args.key?(:apply_to_existing_coursework)
+          @grading_periods = args[:grading_periods] if args.key?(:grading_periods)
+        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.40.0"
+      GEM_VERSION = "0.41.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.16.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250303"
+      REVISION = "20250331"
     end
   end
 end

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

@@ -196,6 +196,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GradingPeriod
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GradingPeriodSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Guardian
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -674,6 +686,7 @@ module Google
       
           property :grade_category, as: 'gradeCategory', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
       
+          property :grading_period_id, as: 'gradingPeriodId'
           property :id, as: 'id'
           property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation
       
@@ -832,6 +845,27 @@ module Google
         end
       end
       
+      class GradingPeriod
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_date, as: 'endDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation
+      
+          property :id, as: 'id'
+          property :start_date, as: 'startDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation
+      
+          property :title, as: 'title'
+        end
+      end
+      
+      class GradingPeriodSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :apply_to_existing_coursework, as: 'applyToExistingCoursework'
+          collection :grading_periods, as: 'gradingPeriods', class: Google::Apis::ClassroomV1::GradingPeriod, decorator: Google::Apis::ClassroomV1::GradingPeriod::Representation
+      
+        end
+      end
+      
       class Guardian
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -158,6 +158,39 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns the grading period settings in a course. This method returns the
+        # following error codes: * `PERMISSION_DENIED` if the requesting user isn't
+        # permitted to access the grading period settings in the requested course or for
+        # access errors. * `NOT_FOUND` if the requested course does not exist.
+        # @param [String] course_id
+        #   Required. The identifier of the course.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::ClassroomV1::GradingPeriodSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ClassroomV1::GradingPeriodSettings]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_course_grading_period_settings(course_id, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/courses/{courseId}/gradingPeriodSettings', options)
+          command.response_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
+          command.response_class = Google::Apis::ClassroomV1::GradingPeriodSettings
+          command.params['courseId'] = course_id unless course_id.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Returns a list of courses that the requesting user is permitted to view,
         # restricted to those that match the request. Returned courses are ordered by
         # creation time, with the most recently created coming first. This method
@@ -303,6 +336,59 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates grading period settings of a course. Individual grading periods can be
+        # added, removed, or modified using this method. The requesting user and course
+        # owner must be eligible to modify Grading Periods. For details, see [licensing
+        # requirements](https://developers.google.com/classroom/grading-periods/manage-
+        # grading-periods#licensing_requirements). This method returns the following
+        # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
+        # modify the grading period settings in a course or for access errors: *
+        # UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the
+        # request is malformed. * `NOT_FOUND` if the requested course does not exist.
+        # @param [String] course_id
+        #   Required. The identifier of the course.
+        # @param [Google::Apis::ClassroomV1::GradingPeriodSettings] grading_period_settings_object
+        # @param [String] update_mask
+        #   Mask that identifies which fields in the GradingPeriodSettings to update. The
+        #   GradingPeriodSettings `grading_periods` list will be fully replaced by the
+        #   grading periods specified in the update request. For example: * Grading
+        #   periods included in the list without an ID are considered additions, and a new
+        #   ID will be assigned when the request is made. * Grading periods that currently
+        #   exist, but are missing from the request will be considered deletions. *
+        #   Grading periods with an existing ID and modified data are considered edits.
+        #   Unmodified data will be left as is. * Grading periods included with an unknown
+        #   ID will result in an error. The following fields may be specified: * `
+        #   grading_periods` * `apply_to_existing_coursework`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::ClassroomV1::GradingPeriodSettings] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ClassroomV1::GradingPeriodSettings]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_course_grading_period_settings(course_id, grading_period_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/courses/{courseId}/gradingPeriodSettings', options)
+          command.request_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
+          command.request_object = grading_period_settings_object
+          command.response_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
+          command.response_class = Google::Apis::ClassroomV1::GradingPeriodSettings
+          command.params['courseId'] = course_id unless course_id.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates an alias for a course. This method returns the following error codes: *
         # `PERMISSION_DENIED` if the requesting user is not permitted to create the
         # alias or for access errors. * `NOT_FOUND` if the course does not exist. * `
@@ -1310,9 +1396,7 @@ module Google
         #   CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following
         #   fields may be specified by teachers: * `title` * `description` * `state` * `
         #   due_date` * `due_time` * `max_points` * `scheduled_time` * `
-        #   submission_modification_mode` * `topic_id` * `grading_period_id` Available in [
-        #   V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview)
-        #   and later.
+        #   submission_modification_mode` * `topic_id` * `grading_period_id`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-classroom_v1
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,7 +57,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.40.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.41.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1
 rdoc_options: []
 require_paths: