google-apis-retail_v2 0.17.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74572904cb04af93d243eda58d9b77c7ad4559658934c6da5a9c3d3061dbf336
-  data.tar.gz: 3b11130e1a02ca4d58d5dbddd1ca3b84771c82d2de26885cd4cdfcbfb7c33912
+  metadata.gz: e8bb45145477a776ceb72b50db2b46adbacefb13b3b67eeabd2af3e8bc0dcea3
+  data.tar.gz: 31601e2aaee2576e131c9acdf5cf597609912ee38d4440ce26878605a5548110
 SHA512:
-  metadata.gz: 4187419442b09c33b846674d362ad64c738a9b050c283d4a77a0471239db736cebc88884893694e09952556fbdd54afd732a97dd6e7bab9f7604f90492181341
-  data.tar.gz: ff129f5e07a3745b9ac90ea4269e55a4328b5617029b736cb5d7299398498863b202dd341bae40204c5929d99af640995fa2c01c3acb25aa50cac6dec3200b54
+  metadata.gz: 80023b3c5d7b14adcf00cc87d5f139af3adaaf1ccfc7d67a9d68e09ebf80afc6283d4b8f762da50d7936b8049ac4f032e980db43d4f6782665953bdf006e00a6
+  data.tar.gz: da322e2cec277b5ebef0d92ad342277f9e943770c39af1d278cd7be3355379d9ddd2335cf440c4d78f6019a27bbcc2276e8eea3bc60a42d679a650519a58518b

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-retail_v2
 
+### v0.21.0 (2021-11-10)
+
+* Regenerated from discovery document revision 20211104
+
+### v0.20.0 (2021-11-03)
+
+* Regenerated from discovery document revision 20211028
+
+### v0.19.0 (2021-10-26)
+
+* Regenerated from discovery document revision 20211021
+
+### v0.18.0 (2021-10-12)
+
+* Regenerated from discovery document revision 20211011
+
 ### v0.17.0 (2021-10-05)
 
 * Regenerated from discovery document revision 20210930

data/OVERVIEW.md

@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
 
 More detailed descriptions of the Google simple REST clients are available in two documents.
 
- *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
- *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
+ *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
 
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
 

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

@@ -318,7 +318,7 @@ module Google
         # or the region IDs for "same-day-delivery" to be added for this type. Duplicate
         # IDs will be automatically ignored. At least 1 value is required, and a maximum
         # of 2000 values are allowed. Each value must be a string with a length limit of
-        # 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "
+        # 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
         # REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
         # number of place IDs exceeds 2000 for this type after adding, then the update
         # will be rejected.
@@ -350,8 +350,8 @@ module Google
         end
       end
       
-      # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the AddFulfillmentPlaces method.
+      # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
+      # no meaningful response populated from the AddFulfillmentPlaces method.
       class GoogleCloudRetailV2AddFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -742,7 +742,7 @@ module Google
         # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
         # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
         # maximum of 3000 values are allowed. Each value must be a string with a length
-        # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
+        # limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
         # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `placeIds`
         # @return [Array<String>]
@@ -1032,8 +1032,8 @@ module Google
       
         # Unique identifier provided by client, within the ancestor dataset scope.
         # Ensures idempotency and used for request deduplication. Server-generated if
-        # unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-
-        # 9_]+". This is returned as Operation.name in ImportMetadata. Only supported
+        # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
+        # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
         # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
         # Corresponds to the JSON property `requestId`
         # @return [String]
@@ -1522,7 +1522,7 @@ module Google
         # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
         # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
         # be a UTF-8 encoded string with a length limit of 128 characters. * For
-        # indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
+        # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
         # key0LikeThis or KEY_1_LIKE_THIS.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
@@ -1787,12 +1787,13 @@ module Google
         # @return [String]
         attr_accessor :title
       
-        # Input only. The TTL (time to live) of the product. If it is set, expire_time
-        # is set as current timestamp plus ttl. The derived expire_time is returned in
-        # the output and ttl is left blank when retrieving the Product. If it is set,
-        # the product is not available for SearchService.Search after current timestamp
-        # plus ttl. However, the product can still be retrieved by ProductService.
-        # GetProduct and ProductService.ListProducts.
+        # Input only. The TTL (time to live) of the product. If it is set, it must be a
+        # non-negative value, and expire_time is set as current timestamp plus ttl. The
+        # derived expire_time is returned in the output and ttl is left blank when
+        # retrieving the Product. If it is set, the product is not available for
+        # SearchService.Search after current timestamp plus ttl. However, the product
+        # can still be retrieved by ProductService.GetProduct and ProductService.
+        # ListProducts.
         # Corresponds to the JSON property `ttl`
         # @return [String]
         attr_accessor :ttl
@@ -1951,15 +1952,15 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The type of Products allowed to be ingested into the catalog. Acceptable
-        # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
-        # Products. This means Product.primary_product_id can only be empty or set to
-        # the same value as Product.id. * `variant`: You can only ingest Product.Type.
-        # VARIANT Products. This means Product.primary_product_id cannot be empty. If
-        # this field is set to an invalid value other than these, an INVALID_ARGUMENT
-        # error is returned. If this field is `variant` and
-        # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
-        # is returned. See [Using product levels](https://cloud.google.com/retail/
-        # recommendations-ai/docs/catalog#product-levels) for more details.
+        # values are: * `primary` (default): You can ingest Products of all types. When
+        # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
+        # `variant`: You can only ingest Product.Type.VARIANT Products. This means
+        # Product.primary_product_id cannot be empty. If this field is set to an invalid
+        # value other than these, an INVALID_ARGUMENT error is returned. If this field
+        # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
+        # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
+        # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
+        # details.
         # Corresponds to the JSON property `ingestionProductType`
         # @return [String]
         attr_accessor :ingestion_product_type
@@ -1994,8 +1995,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # ID of the promotion. For example, "free gift". The value value must be a UTF-8
-        # encoded string with a length limit of 128 characters, and match the pattern: a-
-        # zA-Z*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
+        # encoded string with a length limit of 128 characters, and match the pattern: `
+        # a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
         # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
         # (https://support.google.com/merchants/answer/7050148).
         # Corresponds to the JSON property `promotionId`
@@ -2256,7 +2257,7 @@ module Google
         # or the region IDs for "same-day-delivery", to be removed for this type. At
         # least 1 value is required, and a maximum of 2000 values are allowed. Each
         # value must be a string with a length limit of 10 characters, matching the
-        # pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+        # pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
         # INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `placeIds`
         # @return [Array<String>]
@@ -2408,6 +2409,12 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec]
         attr_accessor :query_expansion_spec
       
+        # The search mode of the search request. If not specified, a single search
+        # request triggers both product search and faceted search.
+        # Corresponds to the JSON property `searchMode`
+        # @return [String]
+        attr_accessor :search_mode
+      
         # Information of an end user.
         # Corresponds to the JSON property `userInfo`
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
@@ -2420,16 +2427,17 @@ module Google
         # and a fulfillment ID must be provided in the format of "fulfillmentType.
         # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
         # fulfillment type and "store123" is the store ID. Supported keys are: *
-        # colorFamilies * price * originalPrice * discount * 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.
-        # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
-        # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
-        # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
-        # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
-        # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
+        # colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
+        # 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.place_ids for
+        # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
+        # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
+        # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
+        # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
+        # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
         # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
         # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
         # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -2469,6 +2477,7 @@ module Google
           @page_token = args[:page_token] if args.key?(:page_token)
           @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)
           @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)
@@ -2647,7 +2656,8 @@ module Google
         # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
         # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
         # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
-        # discount" * "rating" * "ratingCount" * "attributes.key"
+        # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
+        # price)"
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
@@ -3432,8 +3442,8 @@ module Google
         end
       end
       
-      # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the AddFulfillmentPlaces method.
+      # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
+      # no meaningful response populated from the AddFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -3446,9 +3456,24 @@ module Google
         end
       end
       
-      # Metadata related to the EnrollSolution method. This will be returned by the
-      # google.longrunning.Operation.metadata field.
-      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+      # Metadata related to the progress of the AddLocalInventories operation.
+      # Currently empty because there is no meaningful metadata populated from the
+      # AddLocalInventories method.
+      class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response of the AddLocalInventories API. Currently empty because there is no
+      # meaningful response populated from the AddLocalInventories method.
+      class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
         def initialize(**args)
@@ -3816,6 +3841,35 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the RemoveLocalInventories operation.
+      # Currently empty because there is no meaningful metadata populated from the
+      # RemoveLocalInventories method.
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response of the RemoveLocalInventories API. Currently empty because there is
+      # no meaningful response populated from the RemoveLocalInventories method.
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Metadata related to the progress of the SetInventory operation. Currently
       # empty because there is no meaningful metadata populated from the SetInventory
       # method.
@@ -3887,8 +3941,8 @@ module Google
         end
       end
       
-      # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the AddFulfillmentPlaces method.
+      # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
+      # no meaningful response populated from the AddFulfillmentPlaces method.
       class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
         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.17.0"
+      GEM_VERSION = "0.21.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210930"
+      REVISION = "20211104"
     end
   end
 end

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

@@ -502,7 +502,13 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+      class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
@@ -598,6 +604,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaSetInventoryMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1346,6 +1364,7 @@ module Google
           property :query, as: 'query'
           property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec::Representation
       
+          property :search_mode, as: 'searchMode'
           property :user_info, as: 'userInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo::Representation
       
           collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -1578,7 +1597,13 @@ module Google
         end
       end
       
-      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+      class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
         end
@@ -1706,6 +1731,18 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2alphaSetInventoryMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -67,10 +67,10 @@ module Google
         #   cloud-retail, contact Cloud Retail support team first.
         # @param [String] device_type
         #   The device type context for completion suggestions. It is useful to apply
-        #   different suggestions on different device types, e.g. DESKTOP, MOBILE. If it
-        #   is empty, the suggestions are across all device types. Supported formats: *
-        #   UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with
-        #   OTHER_, e.g. OTHER_IPHONE.
+        #   different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
+        #   it is empty, the suggestions are across all device types. Supported formats: *
+        #   `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
+        #   `OTHER_`, e.g. `OTHER_IPHONE`.
         # @param [Array<String>, String] language_codes
         #   The list of languages of the query. This is the BCP-47 language code, such as "
         #   en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
@@ -886,9 +886,8 @@ module Google
         # @param [String] placement
         #   Required. The resource name of the search engine placement, such as `projects/*
         #   /locations/global/catalogs/default_catalog/placements/default_search`. This
-        #   field is used to identify the set of models that will be used to make the
-        #   search. We currently support one placement with the following ID: * `
-        #   default_search`.
+        #   field is used to identify the serving configuration name and the set of models
+        #   that will be used to make the search.
         # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
-  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.17.0
-  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2
+  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.21.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []
 require_paths: