google-apis-forms_v1 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf06fafae873ad37ab089f59f60bf97821f4f8a435c29ccdaef2cfba3b0eaf7e
-  data.tar.gz: 507d9c8f35fad518f79ff8d8b228f6f5f6b1e405e5e5e60b1b566abc10ba84d3
+  metadata.gz: a83ee3c33edde1820617e0dca8430d3a5d300ba6a048f5bb3b0252ad1f1cfe7d
+  data.tar.gz: 9cb8f811fb95e8564415e0a4dfeb434595dbb49f9989479b283ea88067793887
 SHA512:
-  metadata.gz: cd6eba39a99add31569ca82c605fb7baee17096cff9f39f05e2f47a637a983503f6e5cc99ee9764a39a18036ca3f3baca58c50e192117413a84dcccb888f2199
-  data.tar.gz: bfb359d935abfd3d4547510a2081413c65fdb0d3c12db0a01df362ee05c262530e04ff9bddb1850ff91f2a9e53d0e34e30c2c24f871dcbc770f9ffd73a148bb7
+  metadata.gz: 6ad7deb0f0c027ea7288425d90f46ab60a02978654662eceb30cfc44cb75d2656ab3a557fbe9a472473cbbe0c61a756bcc3da467033abc8dcc3a5d2833318e5a
+  data.tar.gz: 86a9f9f3342127c38111ca023f535ee90872a8575df6bf5fe3359b00ee0e2646e2e5f2321586ab1976ad2988803ecd6fa0586c629ba9369f901041c4363a56f4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-forms_v1
 
+### v0.17.0 (2025-04-06)
+
+* Regenerated from discovery document revision 20250325
+
+### v0.16.0 (2025-03-16)
+
+* Regenerated from discovery document revision 20250304
+
 ### v0.15.0 (2025-02-26)
 
 * Regenerated from discovery document revision 20250218

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

@@ -542,8 +542,14 @@ 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.
+        # allows the user to submit responses but not edit the questions. For forms that
+        # have `publish_settings` value set, this will be the published form URI.
         # Corresponds to the JSON property `responderUri`
         # @return [String]
         attr_accessor :responder_uri
@@ -553,10 +559,12 @@ module Google
         # of the revision ID may change over time, so it should be treated opaquely. A
         # returned revision ID is only guaranteed to be valid for 24 hours after it has
         # been returned and cannot be shared across users. If the revision ID is
-        # unchanged between calls, then the form has not changed. Conversely, a changed
-        # ID (for the same form and user) usually means the form has been updated;
-        # however, a changed ID can also be due to internal factors such as ID format
-        # changes.
+        # unchanged between calls, then the form *content* has not changed. Conversely,
+        # a changed ID (for the same form and user) usually means the form *content* has
+        # been updated; however, a changed ID can also be due to internal factors such
+        # as ID format changes. Form content excludes form metadata, including: *
+        # sharing settings (who has access to the form) * `publish_settings` (if the
+        # form supports publishing and if it is published)
         # Corresponds to the JSON property `revisionId`
         # @return [String]
         attr_accessor :revision_id
@@ -576,6 +584,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)
@@ -1117,6 +1126,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
@@ -1443,6 +1499,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.15.0"
+      GEM_VERSION = "0.17.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 = "20250218"
+      REVISION = "20250325"
     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
@@ -727,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
@@ -839,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

@@ -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.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-forms_v1
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-03-02 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-forms_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-forms_v1/v0.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-forms_v1/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-forms_v1
 rdoc_options: []
 require_paths: