feat: Automated regeneration of Forms client (#13133)

Auto-created at 2025-03-11 13:16:39 +0000 using the toys pull request generator.

Author: yoshi-code-bot

clients/forms/lib/google_api/forms/v1/api/forms.ex

@@ -105,6 +105,7 @@ defmodule GoogleApi.Forms.V1.Api.Forms do
       *   `:quotaUser` (*type:* `String.t`) - 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.
       *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
       *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
+      *   `:unpublished` (*type:* `boolean()`) - 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.
       *   `:body` (*type:* `GoogleApi.Forms.V1.Model.Form.t`) - 
   *   `opts` (*type:* `keyword()`) - Call options
 
@@ -131,6 +132,7 @@ defmodule GoogleApi.Forms.V1.Api.Forms do
       :quotaUser => :query,
       :uploadType => :query,
       :upload_protocol => :query,
+      :unpublished => :query,
       :body => :body
     }
 
@@ -206,6 +208,68 @@ defmodule GoogleApi.Forms.V1.Api.Forms do
     |> Response.decode(opts ++ [struct: %GoogleApi.Forms.V1.Model.Form{}])
   end
 
+  @doc """
+  Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.
+
+  ## Parameters
+
+  *   `connection` (*type:* `GoogleApi.Forms.V1.Connection.t`) - Connection to server
+  *   `form_id` (*type:* `String.t`) - Required. The ID of the form. You can get the id from `Form.form_id` field.
+  *   `optional_params` (*type:* `keyword()`) - Optional parameters
+      *   `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
+      *   `:access_token` (*type:* `String.t`) - OAuth access token.
+      *   `:alt` (*type:* `String.t`) - Data format for response.
+      *   `:callback` (*type:* `String.t`) - JSONP
+      *   `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
+      *   `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
+      *   `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
+      *   `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
+      *   `:quotaUser` (*type:* `String.t`) - 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.
+      *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
+      *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
+      *   `:body` (*type:* `GoogleApi.Forms.V1.Model.SetPublishSettingsRequest.t`) - 
+  *   `opts` (*type:* `keyword()`) - Call options
+
+  ## Returns
+
+  *   `{:ok, %GoogleApi.Forms.V1.Model.SetPublishSettingsResponse{}}` on success
+  *   `{:error, info}` on failure
+  """
+  @spec forms_forms_set_publish_settings(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
+          {:ok, GoogleApi.Forms.V1.Model.SetPublishSettingsResponse.t()}
+          | {:ok, Tesla.Env.t()}
+          | {:ok, list()}
+          | {:error, any()}
+  def forms_forms_set_publish_settings(connection, form_id, optional_params \\ [], opts \\ []) do
+    optional_params_config = %{
+      :"$.xgafv" => :query,
+      :access_token => :query,
+      :alt => :query,
+      :callback => :query,
+      :fields => :query,
+      :key => :query,
+      :oauth_token => :query,
+      :prettyPrint => :query,
+      :quotaUser => :query,
+      :uploadType => :query,
+      :upload_protocol => :query,
+      :body => :body
+    }
+
+    request =
+      Request.new()
+      |> Request.method(:post)
+      |> Request.url("/v1/forms/{formId}:setPublishSettings", %{
+        "formId" => URI.encode(form_id, &URI.char_unreserved?/1)
+      })
+      |> Request.add_optional_params(optional_params_config, optional_params)
+      |> Request.library_version(@library_version)
+
+    connection
+    |> Connection.execute(request)
+    |> Response.decode(opts ++ [struct: %GoogleApi.Forms.V1.Model.SetPublishSettingsResponse{}])
+  end
+
   @doc """
   Get one response from the form.
 

clients/forms/lib/google_api/forms/v1/metadata.ex

@@ -20,7 +20,7 @@ defmodule GoogleApi.Forms.V1 do
   API client metadata for GoogleApi.Forms.V1.
   """
 
-  @discovery_revision "20250218"
+  @discovery_revision "20250304"
 
   def discovery_revision(), do: @discovery_revision
 end

clients/forms/lib/google_api/forms/v1/model/form.ex

@@ -25,6 +25,7 @@ defmodule GoogleApi.Forms.V1.Model.Form do
   *   `info` (*type:* `GoogleApi.Forms.V1.Model.Info.t`, *default:* `nil`) - Required. The title and description of the form.
   *   `items` (*type:* `list(GoogleApi.Forms.V1.Model.Item.t)`, *default:* `nil`) - Required. A list of the form's items, which can include section headers, questions, embedded media, etc.
   *   `linkedSheetId` (*type:* `String.t`, *default:* `nil`) - Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).
+  *   `publishSettings` (*type:* `GoogleApi.Forms.V1.Model.PublishSettings.t`, *default:* `nil`) - Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
   *   `responderUri` (*type:* `String.t`, *default:* `nil`) - 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.
   *   `revisionId` (*type:* `String.t`, *default:* `nil`) - Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format 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.
   *   `settings` (*type:* `GoogleApi.Forms.V1.Model.FormSettings.t`, *default:* `nil`) - The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
@@ -37,6 +38,7 @@ defmodule GoogleApi.Forms.V1.Model.Form do
           :info => GoogleApi.Forms.V1.Model.Info.t() | nil,
           :items => list(GoogleApi.Forms.V1.Model.Item.t()) | nil,
           :linkedSheetId => String.t() | nil,
+          :publishSettings => GoogleApi.Forms.V1.Model.PublishSettings.t() | nil,
           :responderUri => String.t() | nil,
           :revisionId => String.t() | nil,
           :settings => GoogleApi.Forms.V1.Model.FormSettings.t() | nil
@@ -46,6 +48,7 @@ defmodule GoogleApi.Forms.V1.Model.Form do
   field(:info, as: GoogleApi.Forms.V1.Model.Info)
   field(:items, as: GoogleApi.Forms.V1.Model.Item, type: :list)
   field(:linkedSheetId)
+  field(:publishSettings, as: GoogleApi.Forms.V1.Model.PublishSettings)
   field(:responderUri)
   field(:revisionId)
   field(:settings, as: GoogleApi.Forms.V1.Model.FormSettings)

clients/forms/lib/google_api/forms/v1/model/publish_settings.ex

@@ -0,0 +1,46 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.Forms.V1.Model.PublishSettings do
+  @moduledoc """
+  The publishing settings of a form.
+
+  ## Attributes
+
+  *   `publishState` (*type:* `GoogleApi.Forms.V1.Model.PublishState.t`, *default:* `nil`) - Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn't supported and returns an error.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :publishState => GoogleApi.Forms.V1.Model.PublishState.t() | nil
+        }
+
+  field(:publishState, as: GoogleApi.Forms.V1.Model.PublishState)
+end
+
+defimpl Poison.Decoder, for: GoogleApi.Forms.V1.Model.PublishSettings do
+  def decode(value, options) do
+    GoogleApi.Forms.V1.Model.PublishSettings.decode(value, options)
+  end
+end
+
+defimpl Poison.Encoder, for: GoogleApi.Forms.V1.Model.PublishSettings do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end

clients/forms/lib/google_api/forms/v1/model/publish_state.ex

@@ -0,0 +1,49 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.Forms.V1.Model.PublishState do
+  @moduledoc """
+  The publishing state of a form.
+
+  ## Attributes
+
+  *   `isAcceptingResponses` (*type:* `boolean()`, *default:* `nil`) - Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.
+  *   `isPublished` (*type:* `boolean()`, *default:* `nil`) - Required. Whether the form is published and visible to others.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :isAcceptingResponses => boolean() | nil,
+          :isPublished => boolean() | nil
+        }
+
+  field(:isAcceptingResponses)
+  field(:isPublished)
+end
+
+defimpl Poison.Decoder, for: GoogleApi.Forms.V1.Model.PublishState do
+  def decode(value, options) do
+    GoogleApi.Forms.V1.Model.PublishState.decode(value, options)
+  end
+end
+
+defimpl Poison.Encoder, for: GoogleApi.Forms.V1.Model.PublishState do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end

clients/forms/lib/google_api/forms/v1/model/set_publish_settings_request.ex

@@ -0,0 +1,49 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.Forms.V1.Model.SetPublishSettingsRequest do
+  @moduledoc """
+  Updates the publish settings of a Form.
+
+  ## Attributes
+
+  *   `publishSettings` (*type:* `GoogleApi.Forms.V1.Model.PublishSettings.t`, *default:* `nil`) - Required. The desired publish settings to apply to the form.
+  *   `updateMask` (*type:* `String.t`, *default:* `nil`) - 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.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :publishSettings => GoogleApi.Forms.V1.Model.PublishSettings.t() | nil,
+          :updateMask => String.t() | nil
+        }
+
+  field(:publishSettings, as: GoogleApi.Forms.V1.Model.PublishSettings)
+  field(:updateMask)
+end
+
+defimpl Poison.Decoder, for: GoogleApi.Forms.V1.Model.SetPublishSettingsRequest do
+  def decode(value, options) do
+    GoogleApi.Forms.V1.Model.SetPublishSettingsRequest.decode(value, options)
+  end
+end
+
+defimpl Poison.Encoder, for: GoogleApi.Forms.V1.Model.SetPublishSettingsRequest do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end

clients/forms/lib/google_api/forms/v1/model/set_publish_settings_response.ex

@@ -0,0 +1,49 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.Forms.V1.Model.SetPublishSettingsResponse do
+  @moduledoc """
+  The response of a `SetPublishSettings` request.
+
+  ## Attributes
+
+  *   `formId` (*type:* `String.t`, *default:* `nil`) - Required. The ID of the Form. This is same as the `Form.form_id` field.
+  *   `publishSettings` (*type:* `GoogleApi.Forms.V1.Model.PublishSettings.t`, *default:* `nil`) - The publish settings of the form.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :formId => String.t() | nil,
+          :publishSettings => GoogleApi.Forms.V1.Model.PublishSettings.t() | nil
+        }
+
+  field(:formId)
+  field(:publishSettings, as: GoogleApi.Forms.V1.Model.PublishSettings)
+end
+
+defimpl Poison.Decoder, for: GoogleApi.Forms.V1.Model.SetPublishSettingsResponse do
+  def decode(value, options) do
+    GoogleApi.Forms.V1.Model.SetPublishSettingsResponse.decode(value, options)
+  end
+end
+
+defimpl Poison.Encoder, for: GoogleApi.Forms.V1.Model.SetPublishSettingsResponse do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end