google-cloud-retail-v2 0.13.0 → 0.14.0

data/lib/google/cloud/retail/v2/user_event_service/rest/service_stub.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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/cloud/retail/v2/user_event_service_pb"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module UserEventService
+          module Rest
+            ##
+            # REST service stub for the UserEventService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # 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, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the write_user_event REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::WriteUserEventRequest]
+              #   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::Cloud::Retail::V2::UserEvent]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Retail::V2::UserEvent]
+              #   A result object deserialized from the server's reply
+              def write_user_event request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_write_user_event_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,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Retail::V2::UserEvent.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the collect_user_event REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::CollectUserEventRequest]
+              #   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::Api::HttpBody]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Api::HttpBody]
+              #   A result object deserialized from the server's reply
+              def collect_user_event request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_collect_user_event_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,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Api::HttpBody.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the purge_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::PurgeUserEventsRequest]
+              #   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::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def purge_user_events request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_purge_user_events_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,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the import_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::ImportUserEventsRequest]
+              #   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::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def import_user_events request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_import_user_events_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,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the rejoin_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::RejoinUserEventsRequest]
+              #   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::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def rejoin_user_events request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_rejoin_user_events_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,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the write_user_event REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::WriteUserEventRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_write_user_event_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/userEvents:write",
+                                                          body: "user_event",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the collect_user_event REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::CollectUserEventRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_collect_user_event_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v2/{parent}/userEvents:collect",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the purge_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::PurgeUserEventsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_purge_user_events_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/userEvents:purge",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the import_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::ImportUserEventsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_import_user_events_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/userEvents:import",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the rejoin_user_events REST call
+              #
+              # @param request_pb [::Google::Cloud::Retail::V2::RejoinUserEventsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_rejoin_user_events_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/userEvents:rejoin",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/user_event_service/rest.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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/cloud/retail/v2/version"
+
+require "google/cloud/retail/v2/user_event_service/credentials"
+require "google/cloud/retail/v2/user_event_service/paths"
+require "google/cloud/retail/v2/user_event_service/rest/operations"
+require "google/cloud/retail/v2/user_event_service/rest/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Service for ingesting end user actions on the customer website.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/retail/v2/user_event_service/rest"
+        #     client = ::Google::Cloud::Retail::V2::UserEventService::Rest::Client.new
+        #
+        module UserEventService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/retail/v2/user_event_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/retail/v2/user_event_service.rb

@@ -26,6 +26,7 @@ require "google/cloud/retail/v2/user_event_service/credentials"
 require "google/cloud/retail/v2/user_event_service/paths"
 require "google/cloud/retail/v2/user_event_service/operations"
 require "google/cloud/retail/v2/user_event_service/client"
+require "google/cloud/retail/v2/user_event_service/rest"
 
 module Google
   module Cloud
@@ -39,6 +40,11 @@ module Google
         #     require "google/cloud/retail/v2/user_event_service"
         #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/retail/v2/user_event_service/rest"
+        #     client = ::Google::Cloud::Retail::V2::UserEventService::Rest::Client.new
+        #
         module UserEventService
         end
       end

data/lib/google/cloud/retail/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.13.0"
+        VERSION = "0.14.0"
       end
     end
   end

data/lib/google/cloud/retail/v2.rb

@@ -37,6 +37,11 @@ module Google
       #     require "google/cloud/retail/v2"
       #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new
       #
+      # @example Load this package, including all its services, and instantiate a REST client
+      #
+      #     require "google/cloud/retail/v2"
+      #     client = ::Google::Cloud::Retail::V2::CatalogService::Rest::Client.new
+      #
       module V2
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -197,6 +197,9 @@ files:
 - lib/google/cloud/retail/v2/catalog_service/client.rb
 - lib/google/cloud/retail/v2/catalog_service/credentials.rb
 - lib/google/cloud/retail/v2/catalog_service/paths.rb
+- lib/google/cloud/retail/v2/catalog_service/rest.rb
+- lib/google/cloud/retail/v2/catalog_service/rest/client.rb
+- lib/google/cloud/retail/v2/catalog_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/catalog_service_pb.rb
 - lib/google/cloud/retail/v2/catalog_service_services_pb.rb
 - lib/google/cloud/retail/v2/common_pb.rb
@@ -205,6 +208,10 @@ files:
 - lib/google/cloud/retail/v2/completion_service/credentials.rb
 - lib/google/cloud/retail/v2/completion_service/operations.rb
 - lib/google/cloud/retail/v2/completion_service/paths.rb
+- lib/google/cloud/retail/v2/completion_service/rest.rb
+- lib/google/cloud/retail/v2/completion_service/rest/client.rb
+- lib/google/cloud/retail/v2/completion_service/rest/operations.rb
+- lib/google/cloud/retail/v2/completion_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/completion_service_pb.rb
 - lib/google/cloud/retail/v2/completion_service_services_pb.rb
 - lib/google/cloud/retail/v2/control_pb.rb
@@ -212,6 +219,9 @@ files:
 - lib/google/cloud/retail/v2/control_service/client.rb
 - lib/google/cloud/retail/v2/control_service/credentials.rb
 - lib/google/cloud/retail/v2/control_service/paths.rb
+- lib/google/cloud/retail/v2/control_service/rest.rb
+- lib/google/cloud/retail/v2/control_service/rest/client.rb
+- lib/google/cloud/retail/v2/control_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/control_service_pb.rb
 - lib/google/cloud/retail/v2/control_service_services_pb.rb
 - lib/google/cloud/retail/v2/import_config_pb.rb
@@ -219,6 +229,9 @@ files:
 - lib/google/cloud/retail/v2/prediction_service/client.rb
 - lib/google/cloud/retail/v2/prediction_service/credentials.rb
 - lib/google/cloud/retail/v2/prediction_service/paths.rb
+- lib/google/cloud/retail/v2/prediction_service/rest.rb
+- lib/google/cloud/retail/v2/prediction_service/rest/client.rb
+- lib/google/cloud/retail/v2/prediction_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/prediction_service_pb.rb
 - lib/google/cloud/retail/v2/prediction_service_services_pb.rb
 - lib/google/cloud/retail/v2/product_pb.rb
@@ -227,14 +240,22 @@ files:
 - lib/google/cloud/retail/v2/product_service/credentials.rb
 - lib/google/cloud/retail/v2/product_service/operations.rb
 - lib/google/cloud/retail/v2/product_service/paths.rb
+- lib/google/cloud/retail/v2/product_service/rest.rb
+- lib/google/cloud/retail/v2/product_service/rest/client.rb
+- lib/google/cloud/retail/v2/product_service/rest/operations.rb
+- lib/google/cloud/retail/v2/product_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/product_service_pb.rb
 - lib/google/cloud/retail/v2/product_service_services_pb.rb
 - lib/google/cloud/retail/v2/promotion_pb.rb
 - lib/google/cloud/retail/v2/purge_config_pb.rb
+- lib/google/cloud/retail/v2/rest.rb
 - lib/google/cloud/retail/v2/search_service.rb
 - lib/google/cloud/retail/v2/search_service/client.rb
 - lib/google/cloud/retail/v2/search_service/credentials.rb
 - lib/google/cloud/retail/v2/search_service/paths.rb
+- lib/google/cloud/retail/v2/search_service/rest.rb
+- lib/google/cloud/retail/v2/search_service/rest/client.rb
+- lib/google/cloud/retail/v2/search_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/search_service_pb.rb
 - lib/google/cloud/retail/v2/search_service_services_pb.rb
 - lib/google/cloud/retail/v2/serving_config_pb.rb
@@ -242,6 +263,9 @@ files:
 - lib/google/cloud/retail/v2/serving_config_service/client.rb
 - lib/google/cloud/retail/v2/serving_config_service/credentials.rb
 - lib/google/cloud/retail/v2/serving_config_service/paths.rb
+- lib/google/cloud/retail/v2/serving_config_service/rest.rb
+- lib/google/cloud/retail/v2/serving_config_service/rest/client.rb
+- lib/google/cloud/retail/v2/serving_config_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/serving_config_service_pb.rb
 - lib/google/cloud/retail/v2/serving_config_service_services_pb.rb
 - lib/google/cloud/retail/v2/user_event_pb.rb
@@ -250,6 +274,10 @@ files:
 - lib/google/cloud/retail/v2/user_event_service/credentials.rb
 - lib/google/cloud/retail/v2/user_event_service/operations.rb
 - lib/google/cloud/retail/v2/user_event_service/paths.rb
+- lib/google/cloud/retail/v2/user_event_service/rest.rb
+- lib/google/cloud/retail/v2/user_event_service/rest/client.rb
+- lib/google/cloud/retail/v2/user_event_service/rest/operations.rb
+- lib/google/cloud/retail/v2/user_event_service/rest/service_stub.rb
 - lib/google/cloud/retail/v2/user_event_service_pb.rb
 - lib/google/cloud/retail/v2/user_event_service_services_pb.rb
 - lib/google/cloud/retail/v2/version.rb
@@ -308,5 +336,7 @@ requirements: []
 rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
-summary: API Client library for the Retail V2 API
+summary: Cloud Retail service enables customers to build end-to-end personalized recommendation
+  systems without requiring a high level of expertise in machine learning, recommendation
+  system, or Google Cloud.
 test_files: []