@maxim_mazurok/gapi.client.retail-v2 0.0.20230413 → 0.0.20230420

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +90 -59
  2. package/package.json +1 -1
  3. package/tests.ts +19 -9
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://retail.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20230413
12
+ // Revision: 20230420
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -313,6 +313,8 @@ declare namespace gapi.client {
313
313
  filteringOption?: string;
314
314
  /** Output only. The timestamp when the latest successful tune finished. */
315
315
  lastTuneTime?: string;
316
+ /** Optional. Additional model features config. */
317
+ modelFeaturesConfig?: GoogleCloudRetailV2alphaModelModelFeaturesConfig;
316
318
  /**
317
319
  * Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char
318
320
  * limit of 50. recommendation_model_id has char limit of 40.
@@ -353,6 +355,14 @@ declare namespace gapi.client {
353
355
  /** Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. */
354
356
  updateTime?: string;
355
357
  }
358
+ interface GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig {
359
+ /** Optional. Specifies the context of the model when used in predict requests. Only settable for the `frequently-bought-together` type. Will default to MULTI_CONTEXT if not specified. */
360
+ contextProductsType?: string;
361
+ }
362
+ interface GoogleCloudRetailV2alphaModelModelFeaturesConfig {
363
+ /** Additional configs for frequently-bought-together models. */
364
+ frequentlyBoughtTogetherConfig?: GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig;
365
+ }
356
366
  interface GoogleCloudRetailV2alphaModelPageOptimizationConfig {
357
367
  /**
358
368
  * Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page
@@ -650,6 +660,8 @@ declare namespace gapi.client {
650
660
  filteringOption?: string;
651
661
  /** Output only. The timestamp when the latest successful tune finished. */
652
662
  lastTuneTime?: string;
663
+ /** Optional. Additional model features config. */
664
+ modelFeaturesConfig?: GoogleCloudRetailV2betaModelModelFeaturesConfig;
653
665
  /**
654
666
  * Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char
655
667
  * limit of 50. recommendation_model_id has char limit of 40.
@@ -688,6 +700,14 @@ declare namespace gapi.client {
688
700
  /** Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. */
689
701
  updateTime?: string;
690
702
  }
703
+ interface GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig {
704
+ /** Optional. Specifies the context of the model when used in predict requests. Only settable for the `frequently-bought-together` type. Will default to MULTI_CONTEXT if not specified. */
705
+ contextProductsType?: string;
706
+ }
707
+ interface GoogleCloudRetailV2betaModelModelFeaturesConfig {
708
+ /** Additional configs for frequently-bought-together models. */
709
+ frequentlyBoughtTogetherConfig?: GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig;
710
+ }
691
711
  interface GoogleCloudRetailV2betaModelServingConfigList {
692
712
  /** Optional. A set of valid serving configs that may be used for `PAGE_OPTIMIZATION`. */
693
713
  servingConfigIds?: string[];
@@ -841,10 +861,10 @@ declare namespace gapi.client {
841
861
  /** Results of the matching suggestions. The result list is ordered and the first result is top suggestion. */
842
862
  completionResults?: GoogleCloudRetailV2CompleteQueryResponseCompletionResult[];
843
863
  /**
844
- * Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in
845
- * enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are
846
- * ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches
847
- * are deduplicated. More recent searches will be reserved when duplication happens.
864
+ * Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This
865
+ * feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest
866
+ * to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More
867
+ * recent searches will be reserved when duplication happens.
848
868
  */
849
869
  recentSearchResults?: GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult[];
850
870
  }
@@ -875,7 +895,7 @@ declare namespace gapi.client {
875
895
  lastAllowlistImportOperation?: string;
876
896
  /** Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. */
877
897
  lastDenylistImportOperation?: string;
878
- /** Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. */
898
+ /** Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation. */
879
899
  lastSuggestionsImportOperation?: string;
880
900
  /**
881
901
  * Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s'
@@ -1102,8 +1122,9 @@ declare namespace gapi.client {
1102
1122
  inputConfig?: GoogleCloudRetailV2ProductInputConfig;
1103
1123
  /**
1104
1124
  * Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON
1105
- * string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that
1106
- * `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.
1125
+ * string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that both
1126
+ * `cloud-retail-customer-data-access@system.gserviceaccount.com` and `service-@gcp-sa-retail.iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the topic.
1127
+ * Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1107
1128
  */
1108
1129
  notificationPubsubTopic?: string;
1109
1130
  /** The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
@@ -1212,6 +1233,8 @@ declare namespace gapi.client {
1212
1233
  filteringOption?: string;
1213
1234
  /** Output only. The timestamp when the latest successful tune finished. */
1214
1235
  lastTuneTime?: string;
1236
+ /** Optional. Additional model features config. */
1237
+ modelFeaturesConfig?: GoogleCloudRetailV2ModelModelFeaturesConfig;
1215
1238
  /**
1216
1239
  * Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char
1217
1240
  * limit of 50. recommendation_model_id has char limit of 40.
@@ -1250,6 +1273,14 @@ declare namespace gapi.client {
1250
1273
  /** Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. */
1251
1274
  updateTime?: string;
1252
1275
  }
1276
+ interface GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig {
1277
+ /** Optional. Specifies the context of the model when used in predict requests. Only settable for the `frequently-bought-together` type. Will default to MULTI_CONTEXT if not specified. */
1278
+ contextProductsType?: string;
1279
+ }
1280
+ interface GoogleCloudRetailV2ModelModelFeaturesConfig {
1281
+ /** Additional configs for frequently-bought-together models. */
1282
+ frequentlyBoughtTogetherConfig?: GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig;
1283
+ }
1253
1284
  interface GoogleCloudRetailV2ModelServingConfigList {
1254
1285
  /** Optional. A set of valid serving configs that may be used for `PAGE_OPTIMIZATION`. */
1255
1286
  servingConfigIds?: string[];
@@ -1778,9 +1809,9 @@ declare namespace gapi.client {
1778
1809
  }
1779
1810
  interface GoogleCloudRetailV2RuleFilterAction {
1780
1811
  /**
1781
- * A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. See more details at the Retail
1782
- * Search [user guide](/retail/search/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1",
1783
- * "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
1812
+ * A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see
1813
+ * [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) *
1814
+ * *AND * *(colorFamilies: ANY("Red", "Blue")) *
1784
1815
  */
1785
1816
  filter?: string;
1786
1817
  }
@@ -1814,7 +1845,7 @@ declare namespace gapi.client {
1814
1845
  }
1815
1846
  interface GoogleCloudRetailV2SearchRequest {
1816
1847
  /**
1817
- * Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both
1848
+ * Boost specification to boost certain products. For more information, see [Boost results](https://cloud.google.com/retail/docs/boosting). Notice that if both
1818
1849
  * 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
1819
1850
  * final boost score is equal to the sum of the boost scores from all matched boost conditions.
1820
1851
  */
@@ -1826,8 +1857,8 @@ declare namespace gapi.client {
1826
1857
  branch?: string;
1827
1858
  /**
1828
1859
  * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement
1829
- * such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of
1830
- * the original query. This field is strongly recommended to achieve high search quality. See SearchRequest.filter for more details about filter syntax.
1860
+ * such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter is returned as a supplement of the
1861
+ * original query. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
1831
1862
  */
1832
1863
  canonicalFilter?: string;
1833
1864
  /**
@@ -1843,16 +1874,16 @@ declare namespace gapi.client {
1843
1874
  /** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. */
1844
1875
  facetSpecs?: GoogleCloudRetailV2SearchRequestFacetSpec[];
1845
1876
  /**
1846
- * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See
1847
- * more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
1877
+ * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For
1878
+ * more information, see [Filter](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
1848
1879
  */
1849
1880
  filter?: string;
1850
1881
  /**
1851
1882
  * 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
1852
1883
  * 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 maximum length of 63 characters. * Keys and values can
1853
1884
  * 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 a
1854
- * label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud
1855
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
1885
+ * label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. For more information, see
1886
+ * [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation.
1856
1887
  */
1857
1888
  labels?: { [P in string]: string };
1858
1889
  /**
@@ -1861,8 +1892,8 @@ declare namespace gapi.client {
1861
1892
  */
1862
1893
  offset?: number;
1863
1894
  /**
1864
- * The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See
1865
- * more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
1895
+ * The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For
1896
+ * more information, see [Order](https://cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
1866
1897
  */
1867
1898
  orderBy?: string;
1868
1899
  /**
@@ -1890,8 +1921,8 @@ declare namespace gapi.client {
1890
1921
  /** Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. */
1891
1922
  query?: string;
1892
1923
  /**
1893
- * The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user
1894
- * guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
1924
+ * The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query
1925
+ * expansion](https://cloud.google.com/retail/docs/result-size#query_expansion).
1895
1926
  */
1896
1927
  queryExpansionSpec?: GoogleCloudRetailV2SearchRequestQueryExpansionSpec;
1897
1928
  /** The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. */
@@ -1955,14 +1986,14 @@ declare namespace gapi.client {
1955
1986
  }
1956
1987
  interface GoogleCloudRetailV2SearchRequestFacetSpec {
1957
1988
  /**
1958
- * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered
1959
- * together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked
1960
- * before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to
1961
- * always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google
1962
- * Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false *
1963
- * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be
1964
- * ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that
1965
- * "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
1989
+ * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together
1990
+ * with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with
1991
+ * dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating
1992
+ * facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example,
1993
+ * assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position =
1994
+ * false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender")
1995
+ * or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at
1996
+ * first and second position because their enable_dynamic_position values are false.
1966
1997
  */
1967
1998
  enableDynamicPosition?: boolean;
1968
1999
  /**
@@ -1988,14 +2019,14 @@ declare namespace gapi.client {
1988
2019
  caseInsensitive?: boolean;
1989
2020
  /**
1990
2021
  * Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to
1991
- * "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
2022
+ * "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
1992
2023
  */
1993
2024
  contains?: string[];
1994
2025
  /**
1995
2026
  * Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.
1996
- * For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the
1997
- * model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be
1998
- * returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.
2027
+ * For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the
2028
+ * model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned
2029
+ * in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
1999
2030
  */
2000
2031
  intervals?: GoogleCloudRetailV2Interval[];
2001
2032
  /**
@@ -2015,15 +2046,15 @@ declare namespace gapi.client {
2015
2046
  orderBy?: string;
2016
2047
  /**
2017
2048
  * Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes"
2018
- * to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
2049
+ * to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
2019
2050
  */
2020
2051
  prefixes?: string[];
2021
2052
  /**
2022
- * The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter
2053
+ * The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter
2023
2054
  * expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response,
2024
- * SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized
2025
- * facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will
2026
- * count the products that are both in stock and ship to store "123".
2055
+ * SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for
2056
+ * "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet counts the
2057
+ * products that are both in stock and ship to store "123".
2027
2058
  */
2028
2059
  query?: string;
2029
2060
  /**
@@ -2317,8 +2348,8 @@ declare namespace gapi.client {
2317
2348
  /** The main auto-completion details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
2318
2349
  completionDetail?: GoogleCloudRetailV2CompletionDetail;
2319
2350
  /**
2320
- * The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. It
2321
- * is recommended to set this field to get better per-entity search, completion and prediction results.
2351
+ * The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We
2352
+ * recommend that you set this field to get better per-entity search, completion, and prediction results.
2322
2353
  */
2323
2354
  entity?: string;
2324
2355
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
@@ -2704,12 +2735,12 @@ declare namespace gapi.client {
2704
2735
  }
2705
2736
  interface ProductsResource {
2706
2737
  /**
2707
- * It is recommended to use the ProductService.AddLocalInventories method instead of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories achieves the same results
2708
- * but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does
2709
- * not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a
2710
- * response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations
2711
- * will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be
2712
- * marked as done until being obsolete.
2738
+ * We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the
2739
+ * same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is
2740
+ * asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a
2741
+ * consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The
2742
+ * returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale
2743
+ * updates will not be marked as done until being obsolete.
2713
2744
  */
2714
2745
  addFulfillmentPlaces(request: {
2715
2746
  /** V1 error format. */
@@ -3165,12 +3196,12 @@ declare namespace gapi.client {
3165
3196
  },
3166
3197
  body: GoogleCloudRetailV2Product): Request<GoogleCloudRetailV2Product>;
3167
3198
  /**
3168
- * It is recommended to use the ProductService.RemoveLocalInventories method instead of ProductService.RemoveFulfillmentPlaces. ProductService.RemoveLocalInventories achieves the same
3169
- * results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is
3170
- * asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a
3171
- * consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts.
3172
- * The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the
3173
- * stale updates will not be marked as done until being obsolete.
3199
+ * We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories
3200
+ * achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This
3201
+ * process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed
3202
+ * downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or
3203
+ * ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the
3204
+ * Operations associated with the stale updates will not be marked as done until being obsolete.
3174
3205
  */
3175
3206
  removeFulfillmentPlaces(request: {
3176
3207
  /** V1 error format. */
@@ -4183,7 +4214,7 @@ declare namespace gapi.client {
4183
4214
  /**
4184
4215
  * Required. The resource name of the Retail Search serving config, such as `projects/*‍/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
4185
4216
  * name of the legacy placement resource, such as `projects/*‍/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
4186
- * config name and the set of models that will be used to make the search.
4217
+ * config name and the set of models that are used to make the search.
4187
4218
  */
4188
4219
  placement: string;
4189
4220
  /** Returns response with indentations and line breaks. */
@@ -4215,7 +4246,7 @@ declare namespace gapi.client {
4215
4246
  /**
4216
4247
  * Required. The resource name of the Retail Search serving config, such as `projects/*‍/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
4217
4248
  * name of the legacy placement resource, such as `projects/*‍/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
4218
- * config name and the set of models that will be used to make the search.
4249
+ * config name and the set of models that are used to make the search.
4219
4250
  */
4220
4251
  placement: string;
4221
4252
  /** Returns response with indentations and line breaks. */
@@ -4644,7 +4675,7 @@ declare namespace gapi.client {
4644
4675
  /**
4645
4676
  * Required. The resource name of the Retail Search serving config, such as `projects/*‍/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
4646
4677
  * name of the legacy placement resource, such as `projects/*‍/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
4647
- * config name and the set of models that will be used to make the search.
4678
+ * config name and the set of models that are used to make the search.
4648
4679
  */
4649
4680
  placement: string;
4650
4681
  /** Returns response with indentations and line breaks. */
@@ -4676,7 +4707,7 @@ declare namespace gapi.client {
4676
4707
  /**
4677
4708
  * Required. The resource name of the Retail Search serving config, such as `projects/*‍/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
4678
4709
  * name of the legacy placement resource, such as `projects/*‍/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
4679
- * config name and the set of models that will be used to make the search.
4710
+ * config name and the set of models that are used to make the search.
4680
4711
  */
4681
4712
  placement: string;
4682
4713
  /** Returns response with indentations and line breaks. */
@@ -5012,8 +5043,8 @@ declare namespace gapi.client {
5012
5043
  */
5013
5044
  deviceType?: string;
5014
5045
  /**
5015
- * The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
5016
- * If this is set, it should be exactly matched with UserEvent.entity to get per-entity autocomplete results.
5046
+ * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is
5047
+ * set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.
5017
5048
  */
5018
5049
  entity?: string;
5019
5050
  /** Selector specifying which fields to include in a partial response. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.retail-v2",
3
- "version": "0.0.20230413",
3
+ "version": "0.0.20230420",
4
4
  "description": "TypeScript typings for Retail API v2",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230413
6
+ // Revision: 20230420
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -215,12 +215,12 @@ gapi.load('client', async () => {
215
215
  name: "Test string",
216
216
  });
217
217
  /**
218
- * It is recommended to use the ProductService.AddLocalInventories method instead of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories achieves the same results but
219
- * provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not
220
- * require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is
221
- * returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete
222
- * after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until
223
- * being obsolete.
218
+ * We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the same
219
+ * results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and
220
+ * does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a
221
+ * response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will
222
+ * be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as
223
+ * done until being obsolete.
224
224
  */
225
225
  await gapi.client.retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces({
226
226
  product: "Test string",
@@ -839,8 +839,8 @@ gapi.load('client', async () => {
839
839
  variants: undefined,
840
840
  });
841
841
  /**
842
- * It is recommended to use the ProductService.RemoveLocalInventories method instead of ProductService.RemoveFulfillmentPlaces. ProductService.RemoveLocalInventories achieves the same
843
- * results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is
842
+ * We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories achieves
843
+ * the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is
844
844
  * asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a
845
845
  * consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The
846
846
  * returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale
@@ -1265,6 +1265,11 @@ gapi.load('client', async () => {
1265
1265
  displayName: "Test string",
1266
1266
  filteringOption: "Test string",
1267
1267
  lastTuneTime: "Test string",
1268
+ modelFeaturesConfig: {
1269
+ frequentlyBoughtTogetherConfig: {
1270
+ contextProductsType: "Test string",
1271
+ },
1272
+ },
1268
1273
  name: "Test string",
1269
1274
  optimizationObjective: "Test string",
1270
1275
  periodicTuningState: "Test string",
@@ -1305,6 +1310,11 @@ gapi.load('client', async () => {
1305
1310
  displayName: "Test string",
1306
1311
  filteringOption: "Test string",
1307
1312
  lastTuneTime: "Test string",
1313
+ modelFeaturesConfig: {
1314
+ frequentlyBoughtTogetherConfig: {
1315
+ contextProductsType: "Test string",
1316
+ },
1317
+ },
1308
1318
  name: "Test string",
1309
1319
  optimizationObjective: "Test string",
1310
1320
  periodicTuningState: "Test string",