google-apis-retail_v2alpha 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc97dcae81e3de777b4b63166b309e307df06890111fa84dab2ec3578069b5fa
-  data.tar.gz: cea589c40ae8f3cb627e34316c25912ea01dc7a554bdc1f5aa4ff7922f584e4c
+  metadata.gz: 44ef2bee884e2a8c93ee4268acf06f7446811fd0014b197dd60e96af99fbb13a
+  data.tar.gz: 23edf9bc572404b7b07a4d6ee298de46ba1255012d2074cdb0f698189230c771
 SHA512:
-  metadata.gz: 2f676dea871f7d524f472fcc09b0fd07e66b904093186222d0d062e02e62c166bbc51bb57c65b4b177d5fd6b3efe14fa5776b5c72a4ce790ef6700472a11ef3b
-  data.tar.gz: bf53d423e21173419dc47fe59f1f0eba340af03d6fec9a94f3f47c84b31d9172277edc728dffcb887a00ec97dedd74f6730c8085767ee84e438d6ed0a459efda
+  metadata.gz: 56f362bba0bca18125e0a2885b4aee78d1aea4105f30e857b9dd5bc74b06e9e9dd5588039f3ce428a177c1d734601c8a3d7c027af8164068da92e2acd2758aa5
+  data.tar.gz: 2206ecb4d022eb2b5190ce5f248a9886d3ed4b30761b3ab6f0809a660bfacd8ffb2a9f556fcfcf4f24bca6bcac3ef6412f040e64b96a994ae48661fbde4e3833

data/CHANGELOG.md

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

data/lib/google/apis/retail_v2alpha/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
       
@@ -295,7 +295,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
       
@@ -310,7 +311,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
       
@@ -323,8 +324,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
       
@@ -717,7 +719,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
       
@@ -730,7 +732,7 @@ module Google
         end
       end
       
-      # Request message for AddFulfillmentPlaces method.
+      # Request message for ProductService.AddFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest
         include Google::Apis::Core::Hashable
       
@@ -787,7 +789,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
       
@@ -802,7 +805,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
       
@@ -815,7 +818,7 @@ module Google
         end
       end
       
-      # Request message for AddLocalInventories method.
+      # Request message for ProductService.AddLocalInventories method.
       class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
         include Google::Apis::Core::Hashable
       
@@ -866,8 +869,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
       
@@ -1084,12 +1088,13 @@ module Google
         # Output only. Indicates whether this attribute has been used by any products. `
         # True` if at least one Product is using this attribute in Product.attributes.
         # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
-        # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
-        # This field is `False` for pre-loaded CatalogAttributes. Only CatalogAttributes
-        # that are not in use by products can be deleted. CatalogAttributes that are in
-        # use by products cannot be deleted; however, their configuration properties
-        # will reset to default values upon removal request. After catalog changes, it
-        # takes about 10 minutes for this field to update.
+        # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
+        # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
+        # loaded CatalogAttributes. Only CatalogAttributes that are not in use by
+        # products can be deleted. CatalogAttributes that are in use by products cannot
+        # be deleted; however, their configuration properties will reset to default
+        # values upon removal request. After catalog changes, it takes about 10 minutes
+        # for this field to update.
         # Corresponds to the JSON property `inUse`
         # @return [Boolean]
         attr_accessor :in_use
@@ -1569,11 +1574,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
@@ -1588,11 +1594,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
@@ -2459,7 +2465,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
@@ -2587,9 +2593,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
@@ -2952,9 +2958,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
@@ -4138,7 +4144,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
@@ -4224,6 +4230,11 @@ module Google
         # @return [String]
         attr_accessor :search_mode
       
+        # The specification for query spell correction.
+        # Corresponds to the JSON property `spellCorrectionSpec`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec]
+        attr_accessor :spell_correction_spec
+      
         # Information of an end user.
         # Corresponds to the JSON property `userInfo`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
@@ -4239,8 +4250,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.
@@ -4292,6 +4303,7 @@ module Google
           @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
           @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
           @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)
@@ -4595,6 +4607,26 @@ module Google
         end
       end
       
+      # The specification for query spell correction.
+      class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
+        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 GoogleCloudRetailV2alphaSearchResponse
         include Google::Apis::Core::Hashable
@@ -4613,8 +4645,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
@@ -4643,8 +4675,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
@@ -4841,11 +4873,11 @@ module Google
         # Condition boost specifications. If a product matches multiple conditions in
         # the specifications, boost scores from these specifications are all applied and
         # combined in a non-linear way. Maximum number of specifications is 100. Notice
-        # that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
-        # are set, the boost conditions from both places are evaluated. If a search
-        # request matches multiple boost conditions, the final boost score is equal to
-        # the sum of the boost scores from all matched boost conditions. Can only be set
-        # if solution_types is SOLUTION_TYPE_SEARCH.
+        # that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are
+        # set, the boost conditions from both places are evaluated. If a search request
+        # matches multiple boost conditions, the final boost score is equal to the sum
+        # of the boost scores from all matched boost conditions. Can only be set if
+        # solution_types is SOLUTION_TYPE_SEARCH.
         # Corresponds to the JSON property `boostControlIds`
         # @return [Array<String>]
         attr_accessor :boost_control_ids
@@ -5486,7 +5518,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
       
@@ -5500,7 +5532,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
       
@@ -5515,7 +5548,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
       
@@ -5528,8 +5561,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_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.39.0"
+      GEM_VERSION = "0.40.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_v2alpha/representations.rb

@@ -766,6 +766,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaSearchResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2123,6 +2129,8 @@ module Google
       
           property :relevance_threshold, as: 'relevanceThreshold'
           property :search_mode, as: 'searchMode'
+          property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec::Representation
+      
           property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
       
           collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -2194,6 +2202,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :mode, as: 'mode'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaSearchResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -1074,9 +1074,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_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.39.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.40.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []