google-apis-retail_v2beta 0.98.0 → 0.100.0

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

@@ -54,6 +54,75 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Get the AlertConfig of the requested project.
+        # @param [String] name
+        #   Required. Full AlertConfig resource name. Format: projects/`project_number`/
+        #   alertConfig
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_alert_config(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2beta/{+name}', options)
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Update the alert config of the requested project.
+        # @param [String] name
+        #   Required. Immutable. The name of the AlertConfig singleton resource. Format:
+        #   projects/*/alertConfig
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig] google_cloud_retail_v2beta_alert_config_object
+        # @param [String] update_mask
+        #   Indicates which fields in the provided AlertConfig to update. If not set, all
+        #   supported fields are updated.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_project_alert_config(name, google_cloud_retail_v2beta_alert_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2beta/{+name}', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig::Representation
+          command.request_object = google_cloud_retail_v2beta_alert_config_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAlertConfig
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Completes the specified prefix with keyword suggestions. This feature is only
         # available for users who have Retail Search enabled. Enable Retail Search on
         # Cloud Console before using this feature.
@@ -75,8 +144,8 @@ module Google
         #   all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `
         #   MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
         # @param [Boolean] enable_attribute_suggestions
-        #   If true, attribute suggestions are enabled and provided in response. This
-        #   field is only available for "cloud-retail" dataset.
+        #   If true, attribute suggestions are enabled and provided in the response. This
+        #   field is only available for the "cloud-retail" dataset.
         # @param [String] entity
         #   The entity for customers who run multiple entities, domains, sites, or regions,
         #   for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`,
@@ -269,6 +338,38 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Manages overal generative question feature state -- enables toggling feature
+        # on and off.
+        # @param [String] catalog
+        #   Required. Resource name of the parent catalog. Format: projects/`project`/
+        #   locations/`location`/catalogs/`catalog`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2beta/{+catalog}/generativeQuestionFeature', options)
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Lists all the Catalogs associated with the project.
         # @param [String] parent
         #   Required. The account resource name with an associated location. If the caller
@@ -486,6 +587,85 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Allows management of individual questions.
+        # @param [String] catalog
+        #   Required. Resource name of the catalog. Format: projects/`project`/locations/`
+        #   location`/catalogs/`catalog`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig] google_cloud_retail_v2beta_generative_question_config_object
+        # @param [String] update_mask
+        #   Optional. Indicates which fields in the provided GenerativeQuestionConfig to
+        #   update. The following are NOT supported: * GenerativeQuestionConfig.frequency
+        #   If not set or empty, all supported fields are updated.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_project_location_catalog_generative_question(catalog, google_cloud_retail_v2beta_generative_question_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2beta/{+catalog}/generativeQuestion', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig::Representation
+          command.request_object = google_cloud_retail_v2beta_generative_question_config_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Manages overal generative question feature state -- enables toggling feature
+        # on and off.
+        # @param [String] catalog
+        #   Required. Resource name of the affected catalog. Format: projects/`project`/
+        #   locations/`location`/catalogs/`catalog`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig] google_cloud_retail_v2beta_generative_questions_feature_config_object
+        # @param [String] update_mask
+        #   Optional. Indicates which fields in the provided
+        #   GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported
+        #   fields are updated.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_project_location_catalog_generative_question_feature(catalog, google_cloud_retail_v2beta_generative_questions_feature_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2beta/{+catalog}/generativeQuestionFeature', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig::Representation
+          command.request_object = google_cloud_retail_v2beta_generative_questions_feature_config_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Adds the specified CatalogAttribute to the AttributesConfig. If the
         # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
         # @param [String] attributes_config
@@ -835,6 +1015,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports multiple Products.
+        # @param [String] parent
+        #   Required. Resource name of a Branch, and `default_branch` for branch_id
+        #   component is supported. For example `projects/1234/locations/global/catalogs/
+        #   default_catalog/branches/default_branch`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportProductsRequest] google_cloud_retail_v2beta_export_products_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_export_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta/{+parent}/products:export', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportProductsRequest::Representation
+          command.request_object = google_cloud_retail_v2beta_export_products_request_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets a Product.
         # @param [String] name
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
@@ -1440,6 +1655,71 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Allows management of multiple questions.
+        # @param [String] parent
+        #   Optional. Resource name of the parent catalog. Format: projects/`project`/
+        #   locations/`location`/catalogs/`catalog`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest] google_cloud_retail_v2beta_batch_update_generative_question_configs_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def batch_project_location_catalog_generative_question_update(parent, google_cloud_retail_v2beta_batch_update_generative_question_configs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta/{+parent}/generativeQuestion:batchUpdate', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest::Representation
+          command.request_object = google_cloud_retail_v2beta_batch_update_generative_question_configs_request_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Returns all questions for a given catalog.
+        # @param [String] parent
+        #   Required. Resource name of the parent catalog. Format: projects/`project`/
+        #   locations/`location`/catalogs/`catalog`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2beta/{+parent}/generativeQuestions', options)
+          command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a new model.
         # @param [String] parent
         #   Required. The parent resource under which to create the model. Format: `
@@ -2279,6 +2559,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports user events. `Operation.response` is of type `ExportResponse`. `
+        # Operation.metadata` is of type `ExportMetadata`.
+        # @param [String] parent
+        #   Required. Resource name of a Catalog. For example `projects/1234/locations/
+        #   global/catalogs/default_catalog`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportUserEventsRequest] google_cloud_retail_v2beta_export_user_events_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_export_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:export', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportUserEventsRequest::Representation
+          command.request_object = google_cloud_retail_v2beta_export_user_events_request_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Bulk import of User events. Request processing might be synchronous. Events
         # that already exist are skipped. Use this method for backfilling historical
         # user events. `Operation.response` is of type `ImportResponse`. Note that it is

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2beta
 version: !ruby/object:Gem::Version
-  version: 0.98.0
+  version: 0.100.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-26 00:00:00.000000000 Z
+date: 2024-12-04 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_v2beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.98.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.100.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Vertex AI Search for Retail API V2beta