google-shopping-merchant-accounts-v1 0.a → 0.1.0

data/lib/google/shopping/merchant/accounts/v1/email_preferences_service/rest/service_stub.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/shopping/merchant/accounts/v1/emailpreferences_pb"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          module EmailPreferencesService
+            module Rest
+              ##
+              # REST service stub for the EmailPreferencesService service.
+              # Service stub contains baseline method implementations
+              # including transcoding, making the REST call, and deserialing the response.
+              #
+              class ServiceStub
+                # @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"
+
+                  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                               endpoint_template: endpoint_template,
+                                                               universe_domain: universe_domain,
+                                                               credentials: credentials,
+                                                               numeric_enums: true,
+                                                               service_name: self.class,
+                                                               raise_faraday_errors: false,
+                                                               logger: logger
+                end
+
+                ##
+                # The effective universe domain
+                #
+                # @return [String]
+                #
+                def universe_domain
+                  @client_stub.universe_domain
+                end
+
+                ##
+                # The effective endpoint
+                #
+                # @return [String]
+                #
+                def endpoint
+                  @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_email_preferences REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::GetEmailPreferencesRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Shopping::Merchant::Accounts::V1::EmailPreferences]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::EmailPreferences]
+                #   A result object deserialized from the server's reply
+                def get_email_preferences request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_get_email_preferences_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split "=", 2 }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "get_email_preferences",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::EmailPreferences.decode_json response.body, ignore_unknown_fields: true
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
+                end
+
+                ##
+                # Baseline implementation for the update_email_preferences REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UpdateEmailPreferencesRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Shopping::Merchant::Accounts::V1::EmailPreferences]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::EmailPreferences]
+                #   A result object deserialized from the server's reply
+                def update_email_preferences request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_update_email_preferences_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split "=", 2 }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "update_email_preferences",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::EmailPreferences.decode_json response.body, ignore_unknown_fields: true
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the get_email_preferences REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::GetEmailPreferencesRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_get_email_preferences_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/accounts/v1/{name}",
+                                                            matches: [
+                                                              ["name", %r{^accounts/[^/]+/users/[^/]+/emailPreferences/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the update_email_preferences REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UpdateEmailPreferencesRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_update_email_preferences_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :patch,
+                                                            uri_template: "/accounts/v1/{email_preferences.name}",
+                                                            body: "email_preferences",
+                                                            matches: [
+                                                              ["email_preferences.name", %r{^accounts/[^/]+/users/[^/]+/emailPreferences/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/shopping/merchant/accounts/v1/email_preferences_service/rest.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/shopping/merchant/accounts/v1/version"
+
+require "google/shopping/merchant/accounts/v1/email_preferences_service/credentials"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/paths"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/rest/client"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          ##
+          # Service to support the `EmailPreferences` API.
+          #
+          # To load this service and instantiate a REST client:
+          #
+          #     require "google/shopping/merchant/accounts/v1/email_preferences_service/rest"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::EmailPreferencesService::Rest::Client.new
+          #
+          module EmailPreferencesService
+            # Client for the REST transport
+            module Rest
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/rest/helpers" if ::File.file? helper_path

data/lib/google/shopping/merchant/accounts/v1/email_preferences_service.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/shopping/merchant/accounts/v1/version"
+
+require "google/shopping/merchant/accounts/v1/email_preferences_service/credentials"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/paths"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/client"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/rest"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          ##
+          # Service to support the `EmailPreferences` API.
+          #
+          # @example Load this service and instantiate a gRPC client
+          #
+          #     require "google/shopping/merchant/accounts/v1/email_preferences_service"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::EmailPreferencesService::Client.new
+          #
+          # @example Load this service and instantiate a REST client
+          #
+          #     require "google/shopping/merchant/accounts/v1/email_preferences_service/rest"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::EmailPreferencesService::Rest::Client.new
+          #
+          module EmailPreferencesService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "email_preferences_service", "helpers.rb"
+require "google/shopping/merchant/accounts/v1/email_preferences_service/helpers" if ::File.file? helper_path

data/lib/google/shopping/merchant/accounts/v1/emailpreferences_pb.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/shopping/merchant/accounts/v1/emailpreferences.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/field_mask_pb'
+
+
+descriptor_data = "\n;google/shopping/merchant/accounts/v1/emailpreferences.proto\x12$google.shopping.merchant.accounts.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a google/protobuf/field_mask.proto\"\xe9\x02\n\x10\x45mailPreferences\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12]\n\rnews_and_tips\x18\x02 \x01(\x0e\x32\x41.google.shopping.merchant.accounts.v1.EmailPreferences.OptInStateB\x03\xe0\x41\x01\"X\n\nOptInState\x12\x1c\n\x18OPT_IN_STATE_UNSPECIFIED\x10\x00\x12\r\n\tOPTED_OUT\x10\x01\x12\x0c\n\x08OPTED_IN\x10\x02\x12\x0f\n\x0bUNCONFIRMED\x10\x03:\x88\x01\xea\x41\x84\x01\n+merchantapi.googleapis.com/EmailPreferences\x12\x31\x61\x63\x63ounts/{account}/users/{email}/emailPreferences*\x10\x65mailPreferences2\x10\x65mailPreferences\"_\n\x1aGetEmailPreferencesRequest\x12\x41\n\x04name\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+merchantapi.googleapis.com/EmailPreferences\"\xad\x01\n\x1dUpdateEmailPreferencesRequest\x12V\n\x11\x65mail_preferences\x18\x01 \x01(\x0b\x32\x36.google.shopping.merchant.accounts.v1.EmailPreferencesB\x03\xe0\x41\x02\x12\x34\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x02\x32\xdb\x04\n\x17\x45mailPreferencesService\x12\xd7\x01\n\x13GetEmailPreferences\x12@.google.shopping.merchant.accounts.v1.GetEmailPreferencesRequest\x1a\x36.google.shopping.merchant.accounts.v1.EmailPreferences\"F\xda\x41\x04name\x82\xd3\xe4\x93\x02\x39\x12\x37/accounts/v1/{name=accounts/*/users/*/emailPreferences}\x12\x9c\x02\n\x16UpdateEmailPreferences\x12\x43.google.shopping.merchant.accounts.v1.UpdateEmailPreferencesRequest\x1a\x36.google.shopping.merchant.accounts.v1.EmailPreferences\"\x84\x01\xda\x41\x1d\x65mail_preferences,update_mask\x82\xd3\xe4\x93\x02^2I/accounts/v1/{email_preferences.name=accounts/*/users/*/emailPreferences}:\x11\x65mail_preferences\x1aG\xca\x41\x1amerchantapi.googleapis.com\xd2\x41\'https://www.googleapis.com/auth/contentB\x88\x02\n(com.google.shopping.merchant.accounts.v1B\x15\x45mailPreferencesProtoP\x01ZJcloud.google.com/go/shopping/merchant/accounts/apiv1/accountspb;accountspb\xaa\x02$Google.Shopping.Merchant.Accounts.V1\xca\x02$Google\\Shopping\\Merchant\\Accounts\\V1\xea\x02(Google::Shopping::Merchant::Accounts::V1b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          EmailPreferences = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.EmailPreferences").msgclass
+          EmailPreferences::OptInState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.EmailPreferences.OptInState").enummodule
+          GetEmailPreferencesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.GetEmailPreferencesRequest").msgclass
+          UpdateEmailPreferencesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.accounts.v1.UpdateEmailPreferencesRequest").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/shopping/merchant/accounts/v1/emailpreferences_services_pb.rb

@@ -0,0 +1,64 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/shopping/merchant/accounts/v1/emailpreferences.proto for package 'Google.Shopping.Merchant.Accounts.V1'
+# Original file comments:
+# Copyright 2025 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.
+#
+
+require 'grpc'
+require 'google/shopping/merchant/accounts/v1/emailpreferences_pb'
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          module EmailPreferencesService
+            # Service to support the `EmailPreferences` API.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.shopping.merchant.accounts.v1.EmailPreferencesService'
+
+              # Returns the email preferences for a Merchant Center account user.
+              # This service only permits retrieving and updating email preferences for the
+              # authenticated user.
+              # Use the name=accounts/*/users/me/emailPreferences alias to get preferences
+              # for the authenticated user.
+              rpc :GetEmailPreferences, ::Google::Shopping::Merchant::Accounts::V1::GetEmailPreferencesRequest, ::Google::Shopping::Merchant::Accounts::V1::EmailPreferences
+              # Updates the email preferences for a Merchant Center account user. Advanced
+              # account users should specify the advanced account rather than a sub-account
+              # of the advanced account.
+              #
+              # Preferences which are not explicitly selected in the update mask will not
+              # be updated.
+              #
+              # It is invalid for updates to specify an UNCONFIRMED opt-in status value.
+              #
+              # Use the name=accounts/*/users/me/emailPreferences alias to update
+              # preferences
+              # for the authenticated user.
+              rpc :UpdateEmailPreferences, ::Google::Shopping::Merchant::Accounts::V1::UpdateEmailPreferencesRequest, ::Google::Shopping::Merchant::Accounts::V1::EmailPreferences
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end