google-apis-retail_v2 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd90dc15eae51189a2fdf09351866ee524f8bd62397647b2353c03ae9ca36bad
-  data.tar.gz: 42363471e109c8942ce12d29f5e0c4b5cac38f46b7e67301e62b71471f31ab0d
+  metadata.gz: 21aa629c3a0c4c57e44fc1b3fe592bc1ecd92908121a31f16315238224603c1f
+  data.tar.gz: 126758f4b650cd5b3b7181128c8359976b0a5019c2871fa030916e486a20ad5f
 SHA512:
-  metadata.gz: 21ccfd5f4793c22478f7c65f2cc824b8fe80a70aec1170ede60bc7c0fb457627df7c38450b50b7abd388a90c9a9f3788efcad6ca5e43e8a145ff43bb4c592c47
-  data.tar.gz: 5aeaa410de3a3bb4e502047c077c0e20e93cdb0f3420c3ee6abd65cc899bef6907f8ad960d2c70ce4d879d34c76816ab76f013904dea5441d39d5ec2776cf5fe
+  metadata.gz: 5ebf22a1ca11048758bd1b953a965c01218175706147585de4e4b350a439b6a3f453834917130acec9a9b91884398028cb32c9e6f57b9b8ebec72450cea84903
+  data.tar.gz: b042af707818c22dc4fee730f5de1bef29bbc92a057441ec9882c096098144b5538798779be1f5ede6a79b578a83a3d3c16092090ca25a269d2cdf5462ebbeb1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.38.0 (2022-05-12)
+
+* Regenerated from discovery document revision 20220505
+
 ### v0.37.0 (2022-05-05)
 
 * Regenerated from discovery document revision 20220430

data/lib/google/apis/retail_v2/classes.rb

@@ -281,7 +281,7 @@ module Google
       
       # Metadata related to the progress of the AddFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddFulfillmentPlaces method.
+      # ProductService.AddFulfillmentPlaces method.
       class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -294,7 +294,7 @@ module Google
         end
       end
       
-      # Request message for AddFulfillmentPlaces method.
+      # Request message for ProductService.AddFulfillmentPlaces method.
       class GoogleCloudRetailV2AddFulfillmentPlacesRequest
         include Google::Apis::Core::Hashable
       
@@ -351,7 +351,8 @@ module Google
       end
       
       # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
-      # no meaningful response populated from the AddFulfillmentPlaces method.
+      # no meaningful response populated from the ProductService.AddFulfillmentPlaces
+      # method.
       class GoogleCloudRetailV2AddFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -366,7 +367,7 @@ module Google
       
       # Metadata related to the progress of the AddLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddLocalInventories method.
+      # ProductService.AddLocalInventories method.
       class GoogleCloudRetailV2AddLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -379,7 +380,7 @@ module Google
         end
       end
       
-      # Request message for AddLocalInventories method.
+      # Request message for ProductService.AddLocalInventories method.
       class GoogleCloudRetailV2AddLocalInventoriesRequest
         include Google::Apis::Core::Hashable
       
@@ -430,8 +431,9 @@ module Google
         end
       end
       
-      # Response of the AddLocalInventories API. Currently empty because there is no
-      # meaningful response populated from the AddLocalInventories method.
+      # Response of the ProductService.AddLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # AddLocalInventories method.
       class GoogleCloudRetailV2AddLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
@@ -776,11 +778,12 @@ module Google
       
         # This field is normally ignored unless AttributesConfig.attribute_config_level
         # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
-        # You may learn more on [configuration mode] (https://cloud.google.com/retail/
-        # docs/attribute-config#config-modes). if true, custom attribute values are
-        # indexed, so that it can be filtered, faceted or boosted in SearchService.
-        # Search. This field is ignored in a UserEvent. See SearchRequest.filter,
-        # SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
+        # For information about product-level attribute configuration, see [
+        # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
+        # config-modes). If true, custom attribute values are indexed, so that they can
+        # be filtered, faceted or boosted in SearchService.Search. This field is ignored
+        # in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
+        # SearchRequest.boost_spec for more details.
         # Corresponds to the JSON property `indexable`
         # @return [Boolean]
         attr_accessor :indexable
@@ -795,11 +798,11 @@ module Google
       
         # This field is normally ignored unless AttributesConfig.attribute_config_level
         # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
-        # You may learn more on [configuration mode] (https://cloud.google.com/retail/
-        # docs/attribute-config#config-modes). If true, custom attribute values are
-        # searchable by text queries in SearchService.Search. This field is ignored in a
-        # UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error
-        # is returned.
+        # For information about product-level attribute configuration, see [
+        # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
+        # config-modes). If true, custom attribute values are searchable by text queries
+        # in SearchService.Search. This field is ignored in a UserEvent. Only set if
+        # type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `searchable`
         # @return [Boolean]
         attr_accessor :searchable
@@ -1413,7 +1416,7 @@ module Google
         # The labels applied to a resource must meet the following requirements: * Each
         # resource can have multiple labels, up to a maximum of 64. * Each label must be
         # a key-value pair. * Keys have a minimum length of 1 character and a maximum
-        # length of 63 characters, and cannot be empty. Values can be empty, and have a
+        # length of 63 characters and cannot be empty. Values can be empty and have a
         # maximum length of 63 characters. * Keys and values can contain only lowercase
         # letters, numeric characters, underscores, and dashes. All characters must use
         # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -1541,9 +1544,9 @@ module Google
         attr_accessor :id
       
         # Additional product metadata / annotations. Possible values: * `product`: JSON
-        # representation of the product. Will be set if `returnProduct` is set to true
-        # in `PredictRequest.params`. * `score`: Prediction score in double value. Will
-        # be set if `returnScore` is set to true in `PredictRequest.params`.
+        # representation of the product. Is set if `returnProduct` is set to true in `
+        # PredictRequest.params`. * `score`: Prediction score in double value. Is set if
+        # `returnScore` is set to true in `PredictRequest.params`.
         # Corresponds to the JSON property `metadata`
         # @return [Hash<String,Object>]
         attr_accessor :metadata
@@ -1906,9 +1909,9 @@ module Google
         # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
         # the following fields are always returned in SearchResponse by default: * name
         # For Type.VARIANT, the following fields are always returned in by default: *
-        # name * color_info Maximum number of paths is 30. Otherwise, an
+        # name * color_info The maximum number of paths is 30. Otherwise, an
         # INVALID_ARGUMENT error is returned. Note: Returning more fields in
-        # SearchResponse may increase response payload size and serving latency.
+        # SearchResponse can increase response payload size and serving latency.
         # Corresponds to the JSON property `retrievableFields`
         # @return [String]
         attr_accessor :retrievable_fields
@@ -2589,7 +2592,7 @@ module Google
         # The labels applied to a resource must meet the following requirements: * Each
         # resource can have multiple labels, up to a maximum of 64. * Each label must be
         # a key-value pair. * Keys have a minimum length of 1 character and a maximum
-        # length of 63 characters, and cannot be empty. Values can be empty, and have a
+        # length of 63 characters and cannot be empty. Values can be empty and have a
         # maximum length of 63 characters. * Keys and values can contain only lowercase
         # letters, numeric characters, underscores, and dashes. All characters must use
         # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -2667,6 +2670,11 @@ module Google
         # @return [String]
         attr_accessor :search_mode
       
+        # The specification for query spell correction.
+        # Corresponds to the JSON property `spellCorrectionSpec`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec]
+        attr_accessor :spell_correction_spec
+      
         # Information of an end user.
         # Corresponds to the JSON property `userInfo`
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
@@ -2682,8 +2690,8 @@ module Google
         # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
         # discount * variantId * inventory(place_id,price) * inventory(place_id,
         # original_price) * inventory(place_id,attributes.key), where key is any key in
-        # the Product.inventories.attributes map. * attributes.key, where key is any key
-        # in the Product.attributes map. * pickupInStore.id, where id is any
+        # the Product.local_inventories.attributes map. * attributes.key, where key is
+        # any key in the Product.attributes map. * pickupInStore.id, where id is any
         # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
         # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
         # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
@@ -2734,6 +2742,7 @@ module Google
           @query = args[:query] if args.key?(:query)
           @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
           @search_mode = args[:search_mode] if args.key?(:search_mode)
+          @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
           @user_info = args[:user_info] if args.key?(:user_info)
           @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
           @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -3037,6 +3046,26 @@ module Google
         end
       end
       
+      # The specification for query spell correction.
+      class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
+        include Google::Apis::Core::Hashable
+      
+        # The mode under which spell correction should take effect to replace the
+        # original search query. Default to Mode.AUTO.
+        # Corresponds to the JSON property `mode`
+        # @return [String]
+        attr_accessor :mode
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @mode = args[:mode] if args.key?(:mode)
+        end
+      end
+      
       # Response message for SearchService.Search method.
       class GoogleCloudRetailV2SearchResponse
         include Google::Apis::Core::Hashable
@@ -3055,8 +3084,8 @@ module Google
         attr_accessor :attribution_token
       
         # Contains the spell corrected query, if found. If the spell correction type is
-        # AUTOMATIC, then the search results will be based on corrected_query, otherwise
-        # the original query will be used for search.
+        # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
+        # original query will be used for search.
         # Corresponds to the JSON property `correctedQuery`
         # @return [String]
         attr_accessor :corrected_query
@@ -3085,8 +3114,8 @@ module Google
         attr_accessor :query_expansion_info
       
         # The URI of a customer-defined redirect page. If redirect action is triggered,
-        # no search will be performed, and only redirect_uri and attribution_token will
-        # be set in the response.
+        # no search is performed, and only redirect_uri and attribution_token are set in
+        # the response.
         # Corresponds to the JSON property `redirectUri`
         # @return [String]
         attr_accessor :redirect_uri
@@ -3751,7 +3780,7 @@ module Google
       
       # Metadata related to the progress of the AddFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddFulfillmentPlaces method.
+      # ProductService.AddFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -3765,7 +3794,8 @@ module Google
       end
       
       # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
-      # no meaningful response populated from the AddFulfillmentPlaces method.
+      # no meaningful response populated from the ProductService.AddFulfillmentPlaces
+      # method.
       class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -3780,7 +3810,7 @@ module Google
       
       # Metadata related to the progress of the AddLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddLocalInventories method.
+      # ProductService.AddLocalInventories method.
       class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -3793,8 +3823,9 @@ module Google
         end
       end
       
-      # Response of the AddLocalInventories API. Currently empty because there is no
-      # meaningful response populated from the AddLocalInventories method.
+      # Response of the ProductService.AddLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # AddLocalInventories method.
       class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
@@ -4317,7 +4348,7 @@ module Google
       
       # Metadata related to the progress of the AddFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddFulfillmentPlaces method.
+      # ProductService.AddFulfillmentPlaces method.
       class GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -4331,7 +4362,8 @@ module Google
       end
       
       # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
-      # no meaningful response populated from the AddFulfillmentPlaces method.
+      # no meaningful response populated from the ProductService.AddFulfillmentPlaces
+      # method.
       class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -4346,7 +4378,7 @@ module Google
       
       # Metadata related to the progress of the AddLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # AddLocalInventories method.
+      # ProductService.AddLocalInventories method.
       class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -4359,8 +4391,9 @@ module Google
         end
       end
       
-      # Response of the AddLocalInventories API. Currently empty because there is no
-      # meaningful response populated from the AddLocalInventories method.
+      # Response of the ProductService.AddLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # AddLocalInventories method.
       class GoogleCloudRetailV2betaAddLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.37.0"
+      GEM_VERSION = "0.38.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220430"
+      REVISION = "20220505"
     end
   end
 end

data/lib/google/apis/retail_v2/representations.rb

@@ -454,6 +454,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2SearchResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1508,6 +1514,8 @@ module Google
           property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec::Representation
       
           property :search_mode, as: 'searchMode'
+          property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec::Representation
+      
           property :user_info, as: 'userInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo::Representation
       
           collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -1579,6 +1587,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :mode, as: 'mode'
+        end
+      end
+      
       class GoogleCloudRetailV2SearchResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2/service.rb

@@ -775,9 +775,9 @@ module Google
         # this product will be used. If no inventory fields are set in
         # SetInventoryRequest.set_mask, then any existing inventory information will be
         # preserved. Pre-existing inventory information can only be updated with
-        # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
-        # is only available for users who have Retail Search enabled. Please enable
-        # Retail Search on Cloud Console before using this feature.
+        # SetInventory, ProductService.AddFulfillmentPlaces, and RemoveFulfillmentPlaces.
+        # This feature is only available for users who have Retail Search enabled.
+        # Please enable Retail Search on Cloud Console before using this feature.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.37.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.38.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []