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

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

@@ -0,0 +1,330 @@
+# 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/homepage_pb"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          module HomepageService
+            module Rest
+              ##
+              # REST service stub for the HomepageService 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_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest]
+                #   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::Homepage]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::Homepage]
+                #   A result object deserialized from the server's reply
+                def get_homepage request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_get_homepage_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_homepage",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::Homepage.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_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UpdateHomepageRequest]
+                #   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::Homepage]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::Homepage]
+                #   A result object deserialized from the server's reply
+                def update_homepage request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_update_homepage_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_homepage",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::Homepage.decode_json response.body, ignore_unknown_fields: true
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
+                end
+
+                ##
+                # Baseline implementation for the claim_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest]
+                #   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::Homepage]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::Homepage]
+                #   A result object deserialized from the server's reply
+                def claim_homepage request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_claim_homepage_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: "claim_homepage",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::Homepage.decode_json response.body, ignore_unknown_fields: true
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
+                end
+
+                ##
+                # Baseline implementation for the unclaim_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest]
+                #   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::Homepage]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Shopping::Merchant::Accounts::V1::Homepage]
+                #   A result object deserialized from the server's reply
+                def unclaim_homepage request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_unclaim_homepage_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: "unclaim_homepage",
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Shopping::Merchant::Accounts::V1::Homepage.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_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest]
+                #   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_homepage_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/accounts/v1/{name}",
+                                                            matches: [
+                                                              ["name", %r{^accounts/[^/]+/homepage/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the update_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UpdateHomepageRequest]
+                #   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_homepage_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :patch,
+                                                            uri_template: "/accounts/v1/{homepage.name}",
+                                                            body: "homepage",
+                                                            matches: [
+                                                              ["homepage.name", %r{^accounts/[^/]+/homepage/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the claim_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_claim_homepage_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/accounts/v1/{name}:claim",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["name", %r{^accounts/[^/]+/homepage/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the unclaim_homepage REST call
+                #
+                # @param request_pb [::Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_unclaim_homepage_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/accounts/v1/{name}:unclaim",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["name", %r{^accounts/[^/]+/homepage/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/shopping/merchant/accounts/v1/homepage_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/homepage_service/credentials"
+require "google/shopping/merchant/accounts/v1/homepage_service/paths"
+require "google/shopping/merchant/accounts/v1/homepage_service/rest/client"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          ##
+          # Service to support an API for a store's homepage.
+          #
+          # To load this service and instantiate a REST client:
+          #
+          #     require "google/shopping/merchant/accounts/v1/homepage_service/rest"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new
+          #
+          module HomepageService
+            # 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/homepage_service/rest/helpers" if ::File.file? helper_path

data/lib/google/shopping/merchant/accounts/v1/homepage_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/homepage_service/credentials"
+require "google/shopping/merchant/accounts/v1/homepage_service/paths"
+require "google/shopping/merchant/accounts/v1/homepage_service/client"
+require "google/shopping/merchant/accounts/v1/homepage_service/rest"
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          ##
+          # Service to support an API for a store's homepage.
+          #
+          # @example Load this service and instantiate a gRPC client
+          #
+          #     require "google/shopping/merchant/accounts/v1/homepage_service"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Client.new
+          #
+          # @example Load this service and instantiate a REST client
+          #
+          #     require "google/shopping/merchant/accounts/v1/homepage_service/rest"
+          #     client = ::Google::Shopping::Merchant::Accounts::V1::HomepageService::Rest::Client.new
+          #
+          module HomepageService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "homepage_service", "helpers.rb"
+require "google/shopping/merchant/accounts/v1/homepage_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,73 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/shopping/merchant/accounts/v1/homepage.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/homepage_pb'
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1
+          module HomepageService
+            # Service to support an API for a store's homepage.
+            class Service
+
+              include ::GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.shopping.merchant.accounts.v1.HomepageService'
+
+              # Retrieves a store's homepage.
+              rpc :GetHomepage, ::Google::Shopping::Merchant::Accounts::V1::GetHomepageRequest, ::Google::Shopping::Merchant::Accounts::V1::Homepage
+              # Updates a store's homepage. Executing this method requires admin access.
+              rpc :UpdateHomepage, ::Google::Shopping::Merchant::Accounts::V1::UpdateHomepageRequest, ::Google::Shopping::Merchant::Accounts::V1::Homepage
+              # Claims a store's homepage. Executing this method requires admin access.
+              #
+              # If the homepage is already claimed, this will recheck the
+              # verification (unless the business is exempted from claiming, which also
+              # exempts from verification) and return a successful response. If ownership
+              # can no longer be verified, it will return an error, but it won't clear the
+              # claim.
+              #
+              # In case of failure, a canonical error message is returned:
+              #
+              #    * PERMISSION_DENIED: User doesn't have the necessary permissions on this
+              #    Merchant Center account.
+              #
+              #    * FAILED_PRECONDITION:
+              #
+              #      - The account is not a Merchant Center account.
+              #
+              #      - Merchant Center account doesn't have a homepage.
+              #
+              #      - Claiming failed (in this case the error message contains more
+              #      details).
+              rpc :ClaimHomepage, ::Google::Shopping::Merchant::Accounts::V1::ClaimHomepageRequest, ::Google::Shopping::Merchant::Accounts::V1::Homepage
+              # Unclaims a store's homepage. Executing this method requires admin access.
+              rpc :UnclaimHomepage, ::Google::Shopping::Merchant::Accounts::V1::UnclaimHomepageRequest, ::Google::Shopping::Merchant::Accounts::V1::Homepage
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end