google-cloud-gsuite_add_ons-v1 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 107170c17dd9fe722a9c0c5df2afcd4e996d4c478c1eda87bfa3cf72f16fd3ad
-  data.tar.gz: b5d0679e3ddeffbec7e8054c1800b76c4bbe93ff52ca3de3ba351688c2a993d6
+  metadata.gz: 782b2244eb0f52b26c5f52ecb8acdb2793ce9237abf73572f3f0d84c7a06cc24
+  data.tar.gz: 2b1c011a1d278094ce7ebaa245869e2479e984afba302eb689feb5b1a91dfe71
 SHA512:
-  metadata.gz: f902dd989f0c4330f39867da66ba10bf9de22ffdf2e51471561467a600776df52e0bdffb9c1bb7450f50ca3f63e7bec15abfcf0f9183f0054ecec92f9b85c6ab
-  data.tar.gz: 06d4ce6cc50f25053ccb98b91009098ce16289effb44a09ee506f94aca001fff69ca0a6a388920530ef4664fb64334b3e7a673a54cb7882e3f6109ae5a536556
+  metadata.gz: 1d1c585c9cc54a67a5754425016056998233b5ed18d2352e8fab4f2efbf0f215b21ac85a0db3bc5c23b91ec2efee4d22fce1573fe9769b0abe529d01ddcefac4
+  data.tar.gz: 1a81f1d064831a13e202b39dfecbcb3e3c352e5e039f086fea2c9a63649ae753855d8dd9b2d1a40c4634d39479f9a67f56e945e2c94b749c962da4223a1bbaa4

data/README.md

@@ -43,40 +43,50 @@ for class and method documentation.
 See also the [Product Documentation](https://developers.google.com/workspace/add-ons/)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/gsuite_add_ons/v1"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb

@@ -27,30 +27,30 @@ module Google
           ##
           # Client for the GSuiteAddOns service.
           #
-          # A service for managing Google Workspace Add-ons deployments.
+          # A service for managing Google Workspace add-ons deployments.
           #
-          # A Google Workspace Add-on is a third-party embedded component that can be
+          # A Google Workspace add-on is a third-party embedded component that can be
           # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-          # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+          # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
           # display UI cards, receive contextual information from the host application,
           # and perform actions in the host application (See:
           # https://developers.google.com/gsuite/add-ons/overview for more information).
           #
-          # A Google Workspace Add-on deployment resource specifies metadata about the
+          # A Google Workspace add-on deployment resource specifies metadata about the
           # add-on, including a specification of the entry points in the host application
           # that trigger add-on executions (see:
           # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-          # Add-on deployments defined via the Google Workspace Add-ons API define their
+          # Add-on deployments defined via the Google Workspace add-ons API define their
           # entrypoints using HTTPS URLs (See:
           # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
           #
-          # A Google Workspace Add-on deployment can be installed in developer mode,
+          # A Google Workspace add-on deployment can be installed in developer mode,
           # which allows an add-on developer to test the experience an end-user would see
           # when installing and running the add-on in their G Suite applications.  When
           # running in developer mode, more detailed error messages are exposed in the
           # add-on UI to aid in debugging.
           #
-          # A Google Workspace Add-on deployment can be published to Google Workspace
+          # A Google Workspace add-on deployment can be published to Google Workspace
           # Marketplace, which allows other Google Workspace users to discover and
           # install the add-on.  See:
           # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview
@@ -195,8 +195,28 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
+
+              @g_suite_add_ons_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+            end
+
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @g_suite_add_ons_stub.logger
             end
 
             # Service calls
@@ -220,7 +240,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Name of the project for which to get the Google Workspace Add-ons
+            #     Required. Name of the project for which to get the Google Workspace add-ons
             #     authorization information.
             #
             #     Example: `projects/my_project/authorization`.
@@ -284,7 +304,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :get_authorization, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -377,7 +396,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :create_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -463,7 +481,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :replace_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -551,7 +568,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :get_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -655,7 +671,7 @@ module Google
               @g_suite_add_ons_stub.call_rpc :list_deployments, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @g_suite_add_ons_stub, :list_deployments, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -746,7 +762,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :delete_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -836,7 +851,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :install_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -926,7 +940,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :uninstall_deployment, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1014,7 +1027,6 @@ module Google
 
               @g_suite_add_ons_stub.call_rpc :get_install_status, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1064,6 +1076,13 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
+            #
+            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   external source for authentication to Google Cloud, you must validate it before
+            #   providing it to a Google API client library. Providing an unvalidated credential
+            #   configuration to Google APIs can compromise the security of your systems and data.
+            #   For more information, refer to [Validate credential configurations from external
+            #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
             #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
@@ -1103,6 +1122,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -1127,6 +1151,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/rest/client.rb

@@ -29,30 +29,30 @@ module Google
             ##
             # REST client for the GSuiteAddOns service.
             #
-            # A service for managing Google Workspace Add-ons deployments.
+            # A service for managing Google Workspace add-ons deployments.
             #
-            # A Google Workspace Add-on is a third-party embedded component that can be
+            # A Google Workspace add-on is a third-party embedded component that can be
             # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-            # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+            # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
             # display UI cards, receive contextual information from the host application,
             # and perform actions in the host application (See:
             # https://developers.google.com/gsuite/add-ons/overview for more information).
             #
-            # A Google Workspace Add-on deployment resource specifies metadata about the
+            # A Google Workspace add-on deployment resource specifies metadata about the
             # add-on, including a specification of the entry points in the host application
             # that trigger add-on executions (see:
             # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-            # Add-on deployments defined via the Google Workspace Add-ons API define their
+            # Add-on deployments defined via the Google Workspace add-ons API define their
             # entrypoints using HTTPS URLs (See:
             # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
             #
-            # A Google Workspace Add-on deployment can be installed in developer mode,
+            # A Google Workspace add-on deployment can be installed in developer mode,
             # which allows an add-on developer to test the experience an end-user would see
             # when installing and running the add-on in their G Suite applications.  When
             # running in developer mode, more detailed error messages are exposed in the
             # add-on UI to aid in debugging.
             #
-            # A Google Workspace Add-on deployment can be published to Google Workspace
+            # A Google Workspace add-on deployment can be published to Google Workspace
             # Marketplace, which allows other Google Workspace users to discover and
             # install the add-on.  See:
             # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview
@@ -188,8 +188,28 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
+
+                @g_suite_add_ons_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+              end
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @g_suite_add_ons_stub.logger
               end
 
               # Service calls
@@ -213,7 +233,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. Name of the project for which to get the Google Workspace Add-ons
+              #     Required. Name of the project for which to get the Google Workspace add-ons
               #     authorization information.
               #
               #     Example: `projects/my_project/authorization`.
@@ -270,7 +290,6 @@ module Google
 
                 @g_suite_add_ons_stub.get_authorization request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -356,7 +375,6 @@ module Google
 
                 @g_suite_add_ons_stub.create_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -435,7 +453,6 @@ module Google
 
                 @g_suite_add_ons_stub.replace_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -516,7 +533,6 @@ module Google
 
                 @g_suite_add_ons_stub.get_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -613,7 +629,7 @@ module Google
                 @g_suite_add_ons_stub.list_deployments request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @g_suite_add_ons_stub, :list_deployments, "deployments", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -697,7 +713,6 @@ module Google
 
                 @g_suite_add_ons_stub.delete_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -780,7 +795,6 @@ module Google
 
                 @g_suite_add_ons_stub.install_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -863,7 +877,6 @@ module Google
 
                 @g_suite_add_ons_stub.uninstall_deployment request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -944,7 +957,6 @@ module Google
 
                 @g_suite_add_ons_stub.get_install_status request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -992,6 +1004,13 @@ module Google
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
               #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
+              #
+              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
               #   @return [::Object]
               # @!attribute [rw] scope
               #   The OAuth scopes
@@ -1024,6 +1043,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -1045,6 +1069,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil

data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the get_authorization REST call
               #
@@ -87,16 +99,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_authorization",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::Authorization.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +139,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "create_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -163,16 +179,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "replace_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -201,16 +219,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -239,16 +259,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_deployments",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -277,16 +299,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -315,16 +339,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "install_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -353,16 +379,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "uninstall_deployment",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -391,16 +419,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_install_status",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::GSuiteAddOns::V1::InstallStatus.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##

data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/rest.rb

@@ -31,30 +31,30 @@ module Google
     module GSuiteAddOns
       module V1
         ##
-        # A service for managing Google Workspace Add-ons deployments.
+        # A service for managing Google Workspace add-ons deployments.
         #
-        # A Google Workspace Add-on is a third-party embedded component that can be
+        # A Google Workspace add-on is a third-party embedded component that can be
         # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-        # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+        # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
         # display UI cards, receive contextual information from the host application,
         # and perform actions in the host application (See:
         # https://developers.google.com/gsuite/add-ons/overview for more information).
         #
-        # A Google Workspace Add-on deployment resource specifies metadata about the
+        # A Google Workspace add-on deployment resource specifies metadata about the
         # add-on, including a specification of the entry points in the host application
         # that trigger add-on executions (see:
         # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-        # Add-on deployments defined via the Google Workspace Add-ons API define their
+        # Add-on deployments defined via the Google Workspace add-ons API define their
         # entrypoints using HTTPS URLs (See:
         # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
         #
-        # A Google Workspace Add-on deployment can be installed in developer mode,
+        # A Google Workspace add-on deployment can be installed in developer mode,
         # which allows an add-on developer to test the experience an end-user would see
         # when installing and running the add-on in their G Suite applications.  When
         # running in developer mode, more detailed error messages are exposed in the
         # add-on UI to aid in debugging.
         #
-        # A Google Workspace Add-on deployment can be published to Google Workspace
+        # A Google Workspace add-on deployment can be published to Google Workspace
         # Marketplace, which allows other Google Workspace users to discover and
         # install the add-on.  See:
         # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview

data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons.rb

@@ -32,30 +32,30 @@ module Google
     module GSuiteAddOns
       module V1
         ##
-        # A service for managing Google Workspace Add-ons deployments.
+        # A service for managing Google Workspace add-ons deployments.
         #
-        # A Google Workspace Add-on is a third-party embedded component that can be
+        # A Google Workspace add-on is a third-party embedded component that can be
         # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-        # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+        # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
         # display UI cards, receive contextual information from the host application,
         # and perform actions in the host application (See:
         # https://developers.google.com/gsuite/add-ons/overview for more information).
         #
-        # A Google Workspace Add-on deployment resource specifies metadata about the
+        # A Google Workspace add-on deployment resource specifies metadata about the
         # add-on, including a specification of the entry points in the host application
         # that trigger add-on executions (see:
         # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-        # Add-on deployments defined via the Google Workspace Add-ons API define their
+        # Add-on deployments defined via the Google Workspace add-ons API define their
         # entrypoints using HTTPS URLs (See:
         # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
         #
-        # A Google Workspace Add-on deployment can be installed in developer mode,
+        # A Google Workspace add-on deployment can be installed in developer mode,
         # which allows an add-on developer to test the experience an end-user would see
         # when installing and running the add-on in their G Suite applications.  When
         # running in developer mode, more detailed error messages are exposed in the
         # add-on UI to aid in debugging.
         #
-        # A Google Workspace Add-on deployment can be published to Google Workspace
+        # A Google Workspace add-on deployment can be published to Google Workspace
         # Marketplace, which allows other Google Workspace users to discover and
         # install the add-on.  See:
         # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview

data/lib/google/cloud/gsuite_add_ons/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module GSuiteAddOns
       module V1
-        VERSION = "1.0.1"
+        VERSION = "1.2.0"
       end
     end
   end

data/lib/google/cloud/gsuiteaddons/v1/gsuiteaddons_services_pb.rb

@@ -24,30 +24,30 @@ module Google
     module GSuiteAddOns
       module V1
         module GSuiteAddOns
-          # A service for managing Google Workspace Add-ons deployments.
+          # A service for managing Google Workspace add-ons deployments.
           #
-          # A Google Workspace Add-on is a third-party embedded component that can be
+          # A Google Workspace add-on is a third-party embedded component that can be
           # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-          # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+          # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
           # display UI cards, receive contextual information from the host application,
           # and perform actions in the host application (See:
           # https://developers.google.com/gsuite/add-ons/overview for more information).
           #
-          # A Google Workspace Add-on deployment resource specifies metadata about the
+          # A Google Workspace add-on deployment resource specifies metadata about the
           # add-on, including a specification of the entry points in the host application
           # that trigger add-on executions (see:
           # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-          # Add-on deployments defined via the Google Workspace Add-ons API define their
+          # Add-on deployments defined via the Google Workspace add-ons API define their
           # entrypoints using HTTPS URLs (See:
           # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
           #
-          # A Google Workspace Add-on deployment can be installed in developer mode,
+          # A Google Workspace add-on deployment can be installed in developer mode,
           # which allows an add-on developer to test the experience an end-user would see
           # when installing and running the add-on in their G Suite applications.  When
           # running in developer mode, more detailed error messages are exposed in the
           # add-on UI to aid in debugging.
           #
-          # A Google Workspace Add-on deployment can be published to Google Workspace
+          # A Google Workspace add-on deployment can be published to Google Workspace
           # Marketplace, which allows other Google Workspace users to discover and
           # install the add-on.  See:
           # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview

data/proto_docs/google/api/client.rb

@@ -28,6 +28,9 @@ module Google
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
       #     enabled. By default, asynchronous REST clients will not be generated.
       #     This feature will be enabled by default 1 month after launching the
       #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
       class ExperimentalFeatures
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map of service names to renamed services. Keys are the package relative
+    #     service names and values are the name to be used for the service client
+    #     and call options.
+    #
+    #     publishing:
+    #       go_settings:
+    #         renamed_services:
+    #           Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

data/proto_docs/google/apps/script/type/extension_point.rb

@@ -67,9 +67,13 @@ module Google
         # @!attribute [rw] open_link
         #   @return [::String]
         #     URL to be opened by the UniversalAction.
+        #
+        #     Note: The following fields are mutually exclusive: `open_link`, `run_function`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] run_function
         #   @return [::String]
         #     Endpoint to be run by the UniversalAction.
+        #
+        #     Note: The following fields are mutually exclusive: `run_function`, `open_link`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class UniversalActionExtensionPoint
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/apps/script/type/gmail/gmail_addon_manifest.rb

@@ -69,11 +69,15 @@ module Google
           # @!attribute [rw] open_link
           #   @return [::String]
           #     A link that is opened by Gmail when the user triggers the action.
+          #
+          #     Note: The following fields are mutually exclusive: `open_link`, `run_function`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] run_function
           #   @return [::String]
           #     An endpoint that is called when the user triggers the
           #     action. See the [universal actions
           #     guide](/gmail/add-ons/how-tos/universal-actions) for details.
+          #
+          #     Note: The following fields are mutually exclusive: `run_function`, `open_link`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class UniversalAction
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/apps/script/type/script_manifest.rb

@@ -96,7 +96,7 @@ module Google
           # Default value, equivalent to `SYSTEM_ID_TOKEN`
           HTTP_AUTHORIZATION_HEADER_UNSPECIFIED = 0
 
-          # Send an ID token for the project-specific Google Workspace Add-ons system
+          # Send an ID token for the project-specific Google Workspace add-ons system
           # service account (default)
           SYSTEM_ID_TOKEN = 1
 

data/proto_docs/google/cloud/gsuiteaddons/v1/gsuiteaddons.rb

@@ -21,10 +21,10 @@ module Google
   module Cloud
     module GSuiteAddOns
       module V1
-        # Request message to get Google Workspace Add-ons authorization information.
+        # Request message to get Google Workspace add-ons authorization information.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Name of the project for which to get the Google Workspace Add-ons
+        #     Required. Name of the project for which to get the Google Workspace add-ons
         #     authorization information.
         #
         #     Example: `projects/my_project/authorization`.
@@ -188,7 +188,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A Google Workspace Add-on deployment
+        # A Google Workspace add-on deployment
         # @!attribute [rw] name
         #   @return [::String]
         #     The deployment resource name.
@@ -199,7 +199,7 @@ module Google
         #     user before executing an add-on endpoint.
         # @!attribute [rw] add_ons
         #   @return [::Google::Cloud::GSuiteAddOns::V1::AddOns]
-        #     The Google Workspace Add-on configuration.
+        #     The Google Workspace add-on configuration.
         # @!attribute [rw] etag
         #   @return [::String]
         #     This value is computed by the server based on the version of the
@@ -210,10 +210,10 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A Google Workspace Add-on configuration.
+        # A Google Workspace add-on configuration.
         # @!attribute [rw] common
         #   @return [::Google::Apps::Script::Type::CommonAddOnManifest]
-        #     Configuration that is common across all Google Workspace Add-ons.
+        #     Configuration that is common across all Google Workspace add-ons.
         # @!attribute [rw] gmail
         #   @return [::Google::Apps::Script::Type::Gmail::GmailAddOnManifest]
         #     Gmail add-on configuration.

data/proto_docs/google/protobuf/struct.rb

@@ -53,21 +53,33 @@ module Google
     # @!attribute [rw] null_value
     #   @return [::Google::Protobuf::NullValue]
     #     Represents a null value.
+    #
+    #     Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] number_value
     #   @return [::Float]
     #     Represents a double value.
+    #
+    #     Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] string_value
     #   @return [::String]
     #     Represents a string value.
+    #
+    #     Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] bool_value
     #   @return [::Boolean]
     #     Represents a boolean value.
+    #
+    #     Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] struct_value
     #   @return [::Google::Protobuf::Struct]
     #     Represents a structured value.
+    #
+    #     Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] list_value
     #   @return [::Google::Protobuf::ListValue]
     #     Represents a repeated `Value`.
+    #
+    #     Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     class Value
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-gsuite_add_ons-v1
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -113,7 +112,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -121,15 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Google Workspace Add-ons V1 API
 test_files: []