google-apis-retail_v2alpha 0.80.0 → 0.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8d9cad20049aec00d3a9ccdf255423db226e4b07733b05636ef0b6c3dcefda
-  data.tar.gz: 6fe18f7334623366806864fe5beafb4987aa4091f9915a9bb272d6a93f5e8cc7
+  metadata.gz: eaf8155deb27fe6270c14aebf74446bca6d8e246591ce73d2c62ce68cc20556b
+  data.tar.gz: 06e4a4c787dbbaee5e6ed0a1d34144befac9fdc417eee72530b22f264362acb9
 SHA512:
-  metadata.gz: 3843344510923268c46fe4408bcc5bd4cc8cdd9ff601c91affe93309b92002b127ee701599fb44a6caba86eeb0a562a948cb7aea50deb68032a444260e28fa35
-  data.tar.gz: 3a96d30197a15e0ac03401def4fe0920622a176e4290c129abbd11ac56ce77af5287e68659a62b144dfee701a66fcc149e78d80ca3e0219ab6b9cea36638b185
+  metadata.gz: 3b4bea157f0fa717217b0ab0bd5841a8d9170b8e1f26fbf3ccf0c4c17d31254472fa74d2a67706981ac3b5a20c9822f3d414afc3c1bc31b92793a74335a95363
+  data.tar.gz: 19124d90816c9b7ceb10900d8e23face40db7361977f0988a4e0cf587ab621c50855172a1126bf23d44aa31836cd63ba84878746ec03f290fa4716fb1df8739c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.82.0 (2023-07-23)
+
+* Regenerated from discovery document revision 20230713
+
+### v0.81.0 (2023-07-09)
+
+* Regenerated from discovery document revision 20230629
+
 ### v0.80.0 (2023-07-02)
 
 * Regenerated from discovery document revision 20230622

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

@@ -1008,6 +1008,19 @@ module Google
         end
       end
       
+      # Request for AcceptTerms method.
+      class GoogleCloudRetailV2alphaAcceptTermsRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Request for CatalogService.AddCatalogAttribute method.
       class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
         include Google::Apis::Core::Hashable
@@ -2166,6 +2179,64 @@ module Google
         end
       end
       
+      # Metadata related to the EnrollSolution method. This will be returned by the
+      # google.longrunning.Operation.metadata field.
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Request for EnrollSolution method.
+      class GoogleCloudRetailV2alphaEnrollSolutionRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Solution to enroll.
+        # Corresponds to the JSON property `solution`
+        # @return [String]
+        attr_accessor :solution
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @solution = args[:solution] if args.key?(:solution)
+        end
+      end
+      
+      # Response for EnrollSolution method.
+      class GoogleCloudRetailV2alphaEnrollSolutionResponse
+        include Google::Apis::Core::Hashable
+      
+        # Retail API solution that the project has enrolled.
+        # Corresponds to the JSON property `enrolledSolution`
+        # @return [String]
+        attr_accessor :enrolled_solution
+      
+        # Search solution use case that the project has enrolled.
+        # Corresponds to the JSON property `searchSolutionUseCase`
+        # @return [String]
+        attr_accessor :search_solution_use_case
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @enrolled_solution = args[:enrolled_solution] if args.key?(:enrolled_solution)
+          @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
+        end
+      end
+      
       # Metadata for active A/B testing Experiment.
       class GoogleCloudRetailV2alphaExperimentInfo
         include Google::Apis::Core::Hashable
@@ -2878,6 +2949,25 @@ module Google
         end
       end
       
+      # Response for ListEnrolledSolutions method.
+      class GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Retail API solutions that the project has enrolled.
+        # Corresponds to the JSON property `enrolledSolutions`
+        # @return [Array<String>]
+        attr_accessor :enrolled_solutions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @enrolled_solutions = args[:enrolled_solutions] if args.key?(:enrolled_solutions)
+        end
+      end
+      
       # Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks
       # method.
       class GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse
@@ -3957,11 +4047,11 @@ module Google
         attr_accessor :available_time
       
         # The brands of the product. A maximum of 30 brands are allowed unless
-        # overridden via pantheon UI. Each brand must be a UTF-8 encoded string with a
-        # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
-        # returned. Corresponding properties: Google Merchant Center property [brand](
-        # https://support.google.com/merchants/answer/6324351). Schema.org property [
-        # Product.brand](https://schema.org/brand).
+        # overridden through the Google Cloud console. Each brand must be a UTF-8
+        # encoded string with a length limit of 1,000 characters. Otherwise, an
+        # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
+        # Center property [brand](https://support.google.com/merchants/answer/6324351).
+        # Schema.org property [Product.brand](https://schema.org/brand).
         # Corresponds to the JSON property `brands`
         # @return [Array<String>]
         attr_accessor :brands
@@ -4418,6 +4508,32 @@ module Google
         end
       end
       
+      # Metadata that describes a Cloud Retail Project.
+      class GoogleCloudRetailV2alphaProject
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Retail API solutions that the project has enrolled.
+        # Corresponds to the JSON property `enrolledSolutions`
+        # @return [Array<String>]
+        attr_accessor :enrolled_solutions
+      
+        # Output only. Full resource name of the retail project, such as `projects/`
+        # project_id_or_number`/retailProject`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @enrolled_solutions = args[:enrolled_solutions] if args.key?(:enrolled_solutions)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
       # Promotion specification.
       class GoogleCloudRetailV2alphaPromotion
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.80.0"
+      GEM_VERSION = "0.82.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230622"
+      REVISION = "20230713"
     end
   end
 end

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

@@ -238,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaAcceptTermsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -424,6 +430,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaEnrollSolutionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaEnrollSolutionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaExperimentInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -556,6 +580,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -730,6 +760,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaProject
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaPromotion
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1643,6 +1679,12 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaAcceptTermsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1934,6 +1976,27 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaEnrollSolutionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :solution, as: 'solution'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaEnrollSolutionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :enrolled_solution, as: 'enrolledSolution'
+          property :search_solution_use_case, as: 'searchSolutionUseCase'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaExperimentInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2144,6 +2207,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :enrolled_solutions, as: 'enrolledSolutions'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2481,6 +2551,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaProject
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :enrolled_solutions, as: 'enrolledSolutions'
+          property :name, as: 'name'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaPromotion
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -51,6 +51,106 @@ module Google
           @batch_path = 'batch'
         end
         
+        # The method enrolls a solution of type Retail Search into a project. The
+        # Recommendations AI solution type is enrolled by default when your project
+        # enables Retail API, so you don't need to call the enrollSolution method for
+        # recommendations.
+        # @param [String] project
+        #   Required. Full resource name of parent. Format: `projects/`
+        #   project_number_or_id``
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaEnrollSolutionRequest] google_cloud_retail_v2alpha_enroll_solution_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::RetailV2alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::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 enroll_project_solution(project, google_cloud_retail_v2alpha_enroll_solution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+project}:enrollSolution', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaEnrollSolutionRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_enroll_solution_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
+          command.params['project'] = project unless project.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 the project. Throws `NOT_FOUND` if the project wasn't initialized for the
+        # Retail API service.
+        # @param [String] name
+        #   Required. Full resource name of the project. Format: `projects/`
+        #   project_number_or_id`/retailProject`
+        # @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::RetailV2alpha::GoogleCloudRetailV2alphaProject] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject]
+        #
+        # @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_retail_project(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2alpha/{+name}', options)
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
+          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
+        
+        # Lists all the retail API solutions the project has enrolled.
+        # @param [String] parent
+        #   Required. Full resource name of parent. Format: `projects/`
+        #   project_number_or_id``
+        # @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::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse]
+        #
+        # @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_enrolled_solutions(parent, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2alpha/{+parent}:enrolledSolutions', options)
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListEnrolledSolutionsResponse
+          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
+        
         # 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.
@@ -2678,6 +2778,42 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Accepts service terms for this project. By making requests to this API, you
+        # agree to the terms of service linked below. https://cloud.google.com/retail/
+        # data-use-terms
+        # @param [String] project
+        #   Required. Full resource name of the project. Format: `projects/`
+        #   project_number_or_id`/retailProject`
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAcceptTermsRequest] google_cloud_retail_v2alpha_accept_terms_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::RetailV2alpha::GoogleCloudRetailV2alphaProject] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject]
+        #
+        # @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 accept_project_retail_project_terms(project, google_cloud_retail_v2alpha_accept_terms_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+project}:acceptTerms', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAcceptTermsRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_accept_terms_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProject
+          command.params['project'] = project unless project.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.80.0
+  version: 0.82.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.80.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.82.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []