feat: Automated regeneration of Retail client (googleapis#12570)

Auto-created at 2024-11-19 13:18:18 +0000 using the toys pull request generator.

Author: yoshi-code-bot

clients/retail/README.md

@@ -11,7 +11,7 @@ Install this package from [Hex](https://hex.pm) by adding
 
 ```elixir
 def deps do
-  [{:google_api_retail, "~> 0.18"}]
+  [{:google_api_retail, "~> 0.19"}]
 end
 ```
 

clients/retail/lib/google_api/retail/v2/metadata.ex

@@ -20,7 +20,7 @@ defmodule GoogleApi.Retail.V2 do
   API client metadata for GoogleApi.Retail.V2.
   """
 
-  @discovery_revision "20241024"
+  @discovery_revision "20241114"
 
   def discovery_revision(), do: @discovery_revision
 end

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_big_query_source.ex

@@ -24,7 +24,7 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2BigQuerySource do
   *   `dataSchema` (*type:* `String.t`, *default:* `nil`) - The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
   *   `datasetId` (*type:* `String.t`, *default:* `nil`) - Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
   *   `gcsStagingDir` (*type:* `String.t`, *default:* `nil`) - Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
-  *   `partitionDate` (*type:* `GoogleApi.Retail.V2.Model.GoogleTypeDate.t`, *default:* `nil`) - BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest.
+  *   `partitionDate` (*type:* `GoogleApi.Retail.V2.Model.GoogleTypeDate.t`, *default:* `nil`) - BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
   *   `projectId` (*type:* `String.t`, *default:* `nil`) - The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
   *   `tableId` (*type:* `String.t`, *default:* `nil`) - Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
   """

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_catalog_attribute.ex

@@ -24,7 +24,7 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CatalogAttribute do
   *   `dynamicFacetableOption` (*type:* `String.t`, *default:* `nil`) - If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
   *   `exactSearchableOption` (*type:* `String.t`, *default:* `nil`) - If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
   *   `facetConfig` (*type:* `GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CatalogAttributeFacetConfig.t`, *default:* `nil`) - Contains facet options.
-  *   `inUse` (*type:* `boolean()`, *default:* `nil`) - 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 CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes 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.
+  *   `inUse` (*type:* `boolean()`, *default:* `nil`) - 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 CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes 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.
   *   `indexableOption` (*type:* `String.t`, *default:* `nil`) - When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
   *   `key` (*type:* `String.t`, *default:* `nil`) - Required. Attribute name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named `attributes.abc_xyz` can be indexed, but an attribute named `attributes.abc-xyz` cannot be indexed. If the attribute key starts with `attributes.`, then the attribute is a custom attribute. Attributes such as `brands`, `patterns`, and `title` are built-in and called system attributes.
   *   `retrievableOption` (*type:* `String.t`, *default:* `nil`) - If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_experiment_info.ex

@@ -17,7 +17,7 @@
 
 defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2ExperimentInfo do
   @moduledoc """
-  Metadata for active A/B testing Experiment.
+  Metadata for active A/B testing experiment.
 
   ## Attributes
 

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_experiment_info_serving_config_experiment.ex

@@ -21,7 +21,7 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2ExperimentInfoServingConf
 
   ## Attributes
 
-  *   `experimentServingConfig` (*type:* `String.t`, *default:* `nil`) - The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.
+  *   `experimentServingConfig` (*type:* `String.t`, *default:* `nil`) - The fully qualified resource name of the serving config `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.
   *   `originalServingConfig` (*type:* `String.t`, *default:* `nil`) - The fully qualified resource name of the original SearchRequest.placement in the search request prior to reassignment by experiment API. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.
   """
 

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_local_inventory.ex

@@ -21,10 +21,11 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2LocalInventory do
 
   ## Attributes
 
-  *   `attributes` (*type:* `%{optional(String.t) => GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CustomAttribute.t}`, *default:* `nil`) - Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.
-  *   `fulfillmentTypes` (*type:* `list(String.t)`, *default:* `nil`) - Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
-  *   `placeId` (*type:* `String.t`, *default:* `nil`) - The place ID for the current set of inventory information.
-  *   `priceInfo` (*type:* `GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo.t`, *default:* `nil`) - Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371).
+  *   `attributes` (*type:* `%{optional(String.t) => GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CustomAttribute.t}`, *default:* `nil`) - Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.
+  *   `availability` (*type:* `String.t`, *default:* `nil`) - Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).
+  *   `fulfillmentTypes` (*type:* `list(String.t)`, *default:* `nil`) - Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
+  *   `placeId` (*type:* `String.t`, *default:* `nil`) - Required. The place ID for the current set of inventory information.
+  *   `priceInfo` (*type:* `GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo.t`, *default:* `nil`) - Optional. Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371).
   """
 
   use GoogleApi.Gax.ModelBase
@@ -36,12 +37,14 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2LocalInventory do
                 GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CustomAttribute.t()
             }
             | nil,
+          :availability => String.t() | nil,
           :fulfillmentTypes => list(String.t()) | nil,
           :placeId => String.t() | nil,
           :priceInfo => GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo.t() | nil
         }
 
   field(:attributes, as: GoogleApi.Retail.V2.Model.GoogleCloudRetailV2CustomAttribute, type: :map)
+  field(:availability)
   field(:fulfillmentTypes, type: :list)
   field(:placeId)
   field(:priceInfo, as: GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo)

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_search_response.ex

@@ -25,7 +25,7 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchResponse do
   *   `attributionToken` (*type:* `String.t`, *default:* `nil`) - A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
   *   `conversationalSearchResult` (*type:* `GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchResponseConversationalSearchResult.t`, *default:* `nil`) - This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
   *   `correctedQuery` (*type:* `String.t`, *default:* `nil`) - Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
-  *   `experimentInfo` (*type:* `list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2ExperimentInfo.t)`, *default:* `nil`) - Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.
+  *   `experimentInfo` (*type:* `list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2ExperimentInfo.t)`, *default:* `nil`) - Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
   *   `facets` (*type:* `list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchResponseFacet.t)`, *default:* `nil`) - Results of facets requested by user.
   *   `invalidConditionBoostSpecs` (*type:* `list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec.t)`, *default:* `nil`) - The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
   *   `nextPageToken` (*type:* `String.t`, *default:* `nil`) - A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

clients/retail/lib/google_api/retail/v2/model/google_cloud_retail_v2_user_info.ex

@@ -23,7 +23,7 @@ defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2UserInfo do
 
   *   `directUserRequest` (*type:* `boolean()`, *default:* `nil`) - True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
   *   `ipAddress` (*type:* `String.t`, *default:* `nil`) - The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
-  *   `userAgent` (*type:* `String.t`, *default:* `nil`) - User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+  *   `userAgent` (*type:* `String.t`, *default:* `nil`) - User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
   *   `userId` (*type:* `String.t`, *default:* `nil`) - Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
   """
 

clients/retail/mix.exs

@@ -18,7 +18,7 @@
 defmodule GoogleApi.Retail.Mixfile do
   use Mix.Project
 
-  @version "0.18.0"
+  @version "0.19.0"
 
   def project() do
     [