google-apis-forms_v1 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9473a379aa5c3db66c7173b26550cdcafdcbf27147fd04ea28914631418512
-  data.tar.gz: fc62b17bf3f11590c5db0998ceef58c2169f725082d38d0c2f07a14a013c0578
+  metadata.gz: 487f23bce83a2fd5121efe8a5f8bae24b28bf1dfca67b243ca54678367e61778
+  data.tar.gz: 7bd2cd4690982080f9af99ea6f670ae2b55cb9629b0be71737fd3dae748b4856
 SHA512:
-  metadata.gz: c1654e46ed984a80b40d53a74259ad16a287e9d7a3df2cdb4bcd949094d6feff20fad67b29360a4de4af0f946f7071b2a1cde103e1c5d5f0f9335a6e496cabbc
-  data.tar.gz: aca05c0ef2a97739bd6da13417a2d9dddef8056b45ca114633d3773bbaaf76cf3597f3827f944bee7df266ad7b3bd7c86e2f95179facc063e8499a5131697bf6
+  metadata.gz: 4c701ee4752827716b02343169b2c95066bea35e93487e835c8e607771ccd7f0d781305e439e217554d6fa294e3c0e3bfd159b458ae637569fe170641d985902
+  data.tar.gz: 5a8a6565d80f3e0d1cde94cdce7586c0fb17f765adef9f1f8b2a854ede178efdc8abf01bcd508dd934d54c9fd079eb47cae0715c3af7f961f29586b63bab65f7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-forms_v1
 
+### v0.16.0 (2025-03-16)
+
+* Regenerated from discovery document revision 20250304
+
+### v0.15.0 (2025-02-26)
+
+* Regenerated from discovery document revision 20250218
+* Regenerated using generator version 0.16.0
+
 ### v0.14.0 (2024-11-24)
 
 * Regenerated from discovery document revision 20241112

data/OVERVIEW.md

@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
 
 **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
 
-The [product documentation](https://developers.google.com/forms/api) may provide guidance regarding the preferred client library to use.
+The [product documentation](https://developers.google.com/workspace/forms/api) may provide guidance regarding the preferred client library to use.
 
 ## Supported Ruby versions
 

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

@@ -542,6 +542,11 @@ module Google
         # @return [String]
         attr_accessor :linked_sheet_id
       
+        # The publishing settings of a form.
+        # Corresponds to the JSON property `publishSettings`
+        # @return [Google::Apis::FormsV1::PublishSettings]
+        attr_accessor :publish_settings
+      
         # Output only. The form URI to share with responders. This opens a page that
         # allows the user to submit responses but not edit the questions.
         # Corresponds to the JSON property `responderUri`
@@ -576,6 +581,7 @@ module Google
           @info = args[:info] if args.key?(:info)
           @items = args[:items] if args.key?(:items)
           @linked_sheet_id = args[:linked_sheet_id] if args.key?(:linked_sheet_id)
+          @publish_settings = args[:publish_settings] if args.key?(:publish_settings)
           @responder_uri = args[:responder_uri] if args.key?(:responder_uri)
           @revision_id = args[:revision_id] if args.key?(:revision_id)
           @settings = args[:settings] if args.key?(:settings)
@@ -645,6 +651,12 @@ module Google
       class FormSettings
         include Google::Apis::Core::Hashable
       
+        # Optional. The setting that determines whether the form collects email
+        # addresses from respondents.
+        # Corresponds to the JSON property `emailCollectionType`
+        # @return [String]
+        attr_accessor :email_collection_type
+      
         # Settings related to quiz forms and grading. These must be updated with the
         # UpdateSettingsRequest.
         # Corresponds to the JSON property `quizSettings`
@@ -657,6 +669,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @email_collection_type = args[:email_collection_type] if args.key?(:email_collection_type)
           @quiz_settings = args[:quiz_settings] if args.key?(:quiz_settings)
         end
       end
@@ -1110,6 +1123,53 @@ module Google
         end
       end
       
+      # The publishing settings of a form.
+      class PublishSettings
+        include Google::Apis::Core::Hashable
+      
+        # The publishing state of a form.
+        # Corresponds to the JSON property `publishState`
+        # @return [Google::Apis::FormsV1::PublishState]
+        attr_accessor :publish_state
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @publish_state = args[:publish_state] if args.key?(:publish_state)
+        end
+      end
+      
+      # The publishing state of a form.
+      class PublishState
+        include Google::Apis::Core::Hashable
+      
+        # Required. Whether the form accepts responses. If `is_published` is set to `
+        # false`, this field is forced to `false`.
+        # Corresponds to the JSON property `isAcceptingResponses`
+        # @return [Boolean]
+        attr_accessor :is_accepting_responses
+        alias_method :is_accepting_responses?, :is_accepting_responses
+      
+        # Required. Whether the form is published and visible to others.
+        # Corresponds to the JSON property `isPublished`
+        # @return [Boolean]
+        attr_accessor :is_published
+        alias_method :is_published?, :is_published
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @is_accepting_responses = args[:is_accepting_responses] if args.key?(:is_accepting_responses)
+          @is_published = args[:is_published] if args.key?(:is_published)
+        end
+      end
+      
       # Any question. The specific type of question is known by its `kind`.
       class Question
         include Google::Apis::Core::Hashable
@@ -1436,6 +1496,58 @@ module Google
         end
       end
       
+      # Updates the publish settings of a Form.
+      class SetPublishSettingsRequest
+        include Google::Apis::Core::Hashable
+      
+        # The publishing settings of a form.
+        # Corresponds to the JSON property `publishSettings`
+        # @return [Google::Apis::FormsV1::PublishSettings]
+        attr_accessor :publish_settings
+      
+        # Optional. The `publish_settings` fields to update. This field mask accepts the
+        # following values: * `publish_state`: Updates or replaces all `publish_state`
+        # settings. * `"*"`: Updates or replaces all `publish_settings` fields.
+        # Corresponds to the JSON property `updateMask`
+        # @return [String]
+        attr_accessor :update_mask
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @publish_settings = args[:publish_settings] if args.key?(:publish_settings)
+          @update_mask = args[:update_mask] if args.key?(:update_mask)
+        end
+      end
+      
+      # The response of a `SetPublishSettings` request.
+      class SetPublishSettingsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Required. The ID of the Form. This is same as the `Form.form_id` field.
+        # Corresponds to the JSON property `formId`
+        # @return [String]
+        attr_accessor :form_id
+      
+        # The publishing settings of a form.
+        # Corresponds to the JSON property `publishSettings`
+        # @return [Google::Apis::FormsV1::PublishSettings]
+        attr_accessor :publish_settings
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @form_id = args[:form_id] if args.key?(:form_id)
+          @publish_settings = args[:publish_settings] if args.key?(:publish_settings)
+        end
+      end
+      
       # An answer to a question represented as text.
       class TextAnswer
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FormsV1
       # Version of the google-apis-forms_v1 gem
-      GEM_VERSION = "0.14.0"
+      GEM_VERSION = "0.16.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.1"
+      GENERATOR_VERSION = "0.16.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20241112"
+      REVISION = "20250304"
     end
   end
 end

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

@@ -232,6 +232,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PublishSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PublishState
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Question
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -292,6 +304,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class SetPublishSettingsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class SetPublishSettingsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TextAnswer
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -554,6 +578,8 @@ module Google
           collection :items, as: 'items', class: Google::Apis::FormsV1::Item, decorator: Google::Apis::FormsV1::Item::Representation
       
           property :linked_sheet_id, as: 'linkedSheetId'
+          property :publish_settings, as: 'publishSettings', class: Google::Apis::FormsV1::PublishSettings, decorator: Google::Apis::FormsV1::PublishSettings::Representation
+      
           property :responder_uri, as: 'responderUri'
           property :revision_id, as: 'revisionId'
           property :settings, as: 'settings', class: Google::Apis::FormsV1::FormSettings, decorator: Google::Apis::FormsV1::FormSettings::Representation
@@ -578,6 +604,7 @@ module Google
       class FormSettings
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :email_collection_type, as: 'emailCollectionType'
           property :quiz_settings, as: 'quizSettings', class: Google::Apis::FormsV1::QuizSettings, decorator: Google::Apis::FormsV1::QuizSettings::Representation
       
         end
@@ -726,6 +753,22 @@ module Google
         end
       end
       
+      class PublishSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :publish_state, as: 'publishState', class: Google::Apis::FormsV1::PublishState, decorator: Google::Apis::FormsV1::PublishState::Representation
+      
+        end
+      end
+      
+      class PublishState
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :is_accepting_responses, as: 'isAcceptingResponses'
+          property :is_published, as: 'isPublished'
+        end
+      end
+      
       class Question
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -838,6 +881,24 @@ module Google
         end
       end
       
+      class SetPublishSettingsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :publish_settings, as: 'publishSettings', class: Google::Apis::FormsV1::PublishSettings, decorator: Google::Apis::FormsV1::PublishSettings::Representation
+      
+          property :update_mask, as: 'updateMask'
+        end
+      end
+      
+      class SetPublishSettingsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :form_id, as: 'formId'
+          property :publish_settings, as: 'publishSettings', class: Google::Apis::FormsV1::PublishSettings, decorator: Google::Apis::FormsV1::PublishSettings::Representation
+      
+        end
+      end
+      
       class TextAnswer
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -30,7 +30,7 @@ module Google
       #    Forms = Google::Apis::FormsV1 # Alias the module
       #    service = Forms::FormsService.new
       #
-      # @see https://developers.google.com/forms/api
+      # @see https://developers.google.com/workspace/forms/api
       class FormsService < Google::Apis::Core::BaseService
         DEFAULT_ENDPOINT_TEMPLATE = "https://forms.$UNIVERSE_DOMAIN$/"
 
@@ -91,6 +91,10 @@ module Google
         # items, you must first call forms.create to create an empty form with a title
         # and (optional) document title, and then call forms.update to add the items.
         # @param [Google::Apis::FormsV1::Form] form_object
+        # @param [Boolean] unpublished
+        #   Optional. Whether the form is unpublished. If set to `true`, the form doesn't
+        #   accept responses. If set to `false` or unset, the form is published and
+        #   accepts responses.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -108,12 +112,13 @@ module Google
         # @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 create_form(form_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+        def create_form(form_object = nil, unpublished: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:post, 'v1/forms', options)
           command.request_representation = Google::Apis::FormsV1::Form::Representation
           command.request_object = form_object
           command.response_representation = Google::Apis::FormsV1::Form::Representation
           command.response_class = Google::Apis::FormsV1::Form
+          command.query['unpublished'] = unpublished unless unpublished.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
@@ -149,6 +154,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates the publish settings of a form. Legacy forms aren't supported because
+        # they don't have the `publish_settings` field.
+        # @param [String] form_id
+        #   Required. The ID of the form. You can get the id from `Form.form_id` field.
+        # @param [Google::Apis::FormsV1::SetPublishSettingsRequest] set_publish_settings_request_object
+        # @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::FormsV1::SetPublishSettingsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FormsV1::SetPublishSettingsResponse]
+        #
+        # @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 set_form_publish_settings(form_id, set_publish_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/forms/{formId}:setPublishSettings', options)
+          command.request_representation = Google::Apis::FormsV1::SetPublishSettingsRequest::Representation
+          command.request_object = set_publish_settings_request_object
+          command.response_representation = Google::Apis::FormsV1::SetPublishSettingsResponse::Representation
+          command.response_class = Google::Apis::FormsV1::SetPublishSettingsResponse
+          command.params['formId'] = form_id unless form_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
+        
         # Get one response from the form.
         # @param [String] form_id
         #   Required. The form ID.

data/lib/google/apis/forms_v1.rb

@@ -23,7 +23,7 @@ module Google
     #
     # Reads and writes Google Forms and responses.
     #
-    # @see https://developers.google.com/forms/api
+    # @see https://developers.google.com/workspace/forms/api
     module FormsV1
       # Version of the Google Forms API this client connects to.
       # This is NOT the gem version.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-forms_v1
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,9 +57,8 @@ 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-forms_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-forms_v1/v0.14.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-forms_v1/v0.16.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-forms_v1
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Simple REST client for Google Forms API V1
 test_files: []