google-apis-retail_v2 0.75.0 → 0.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50002aeb176daf77124ef626fc9fe9e419cb604fde481eeb7401d2378b8d2190
-  data.tar.gz: c57d668757cef347893215d032856a6750b861d42e4ec8162d9db69b17bc0d81
+  metadata.gz: 411ffd275f965bbb1222fe08adb710427083a5f38d209b8adc9cde280aca34a4
+  data.tar.gz: 8c8266ef830ae34da8d0db0785267112bb4b0489f5a25cb5fd87d7a3bb0f02d2
 SHA512:
-  metadata.gz: 3383318ba01fa217078faf24c8068192df8f837bf1ee32376db7e4ac68996ad6fd857c3b80b6b9a682870280c4073f141daa328b214cd7bfd0a4de4b385e4fe6
-  data.tar.gz: 5b35b77c8ed6f1e7d061ad3103d745b6833a7677d88dffd71b30c184bf07583932d9a57e26234a346e86d7d295214486ae46eef1635f7f7f069e8a4eec86ede3
+  metadata.gz: 94149dbf45d94ca845eb161ef2253ad84ebfaafee9ee349f6f2a450745b4b6945d56ef73662067e964ba03d4f11c509e7637bdcab5b03cd904c2a6effa8ee43d
+  data.tar.gz: 796bb87ae2012472e6e42fb971f535eb33bbeb61324afa2e48ab1c6db7422124efda01a7abe89d02528b724932deaaecb7b33b282a1ef69856edaa1d197fc1f7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.76.0 (2023-06-18)
+
+* Regenerated from discovery document revision 20230609
+
 ### v0.75.0 (2023-06-04)
 
 * Regenerated from discovery document revision 20230525

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

@@ -3060,6 +3060,115 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeProducts operation. This will be
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudRetailV2PurgeProductsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Count of entries that encountered errors while processing.
+        # Corresponds to the JSON property `failureCount`
+        # @return [Fixnum]
+        attr_accessor :failure_count
+      
+        # Count of entries that were deleted successfully.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @failure_count = args[:failure_count] if args.key?(:failure_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Request message for PurgeProducts method.
+      class GoogleCloudRetailV2PurgeProductsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The filter string to specify the products to be deleted with a
+        # length limit of 5,000 characters. Empty string filter is not allowed. "*"
+        # implies delete all items in a branch. The eligible fields for filtering are: *
+        # `availability`: Double quoted Product.availability string. * `create_time` :
+        # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
+        # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
+        # IN_STOCK" * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
+        # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
+        # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
+        # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
+        # availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND
+        # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
+        # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
+        # queries: * Delete back order products created before a timestamp. create_time <
+        # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # Actually perform the purge. If `force` is set to false, the method will return
+        # the expected purge count without deleting any products.
+        # Corresponds to the JSON property `force`
+        # @return [Boolean]
+        attr_accessor :force
+        alias_method :force?, :force
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @force = args[:force] if args.key?(:force)
+        end
+      end
+      
+      # Response of the PurgeProductsRequest. If the long running operation is
+      # successfully done, then this message is returned by the google.longrunning.
+      # Operations.response field.
+      class GoogleCloudRetailV2PurgeProductsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of products purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        # A sample of the product names that will be deleted. Only populated if `force`
+        # is set to false. A max of 100 names will be returned and the names are chosen
+        # at random.
+        # Corresponds to the JSON property `purgeSample`
+        # @return [Array<String>]
+        attr_accessor :purge_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+          @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
+        end
+      end
+      
       # Request message for PurgeUserEvents method.
       class GoogleCloudRetailV2PurgeUserEventsRequest
         include Google::Apis::Core::Hashable
@@ -7315,6 +7424,74 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeProducts operation. This will be
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudRetailV2betaPurgeProductsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Count of entries that encountered errors while processing.
+        # Corresponds to the JSON property `failureCount`
+        # @return [Fixnum]
+        attr_accessor :failure_count
+      
+        # Count of entries that were deleted successfully.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @failure_count = args[:failure_count] if args.key?(:failure_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Response of the PurgeProductsRequest. If the long running operation is
+      # successfully done, then this message is returned by the google.longrunning.
+      # Operations.response field.
+      class GoogleCloudRetailV2betaPurgeProductsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of products purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        # A sample of the product names that will be deleted. Only populated if `force`
+        # is set to false. A max of 100 names will be returned and the names are chosen
+        # at random.
+        # Corresponds to the JSON property `purgeSample`
+        # @return [Array<String>]
+        attr_accessor :purge_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+          @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
+        end
+      end
+      
       # Response of the PurgeUserEventsRequest. If the long running operation is
       # successfully done, then this message is returned by the google.longrunning.
       # Operations.response field.

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.75.0"
+      GEM_VERSION = "0.76.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 = "20230525"
+      REVISION = "20230609"
     end
   end
 end

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

@@ -454,6 +454,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2PurgeProductsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2PurgeProductsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2PurgeProductsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2PurgeUserEventsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1174,6 +1192,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaPurgeProductsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaPurgeProductsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaPurgeUserEventsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2007,6 +2037,32 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2PurgeProductsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :failure_count, :numeric_string => true, as: 'failureCount'
+          property :success_count, :numeric_string => true, as: 'successCount'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2PurgeProductsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :force, as: 'force'
+        end
+      end
+      
+      class GoogleCloudRetailV2PurgeProductsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+          collection :purge_sample, as: 'purgeSample'
+        end
+      end
+      
       class GoogleCloudRetailV2PurgeUserEventsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3121,6 +3177,24 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaPurgeProductsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :failure_count, :numeric_string => true, as: 'failureCount'
+          property :success_count, :numeric_string => true, as: 'successCount'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2betaPurgeProductsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+          collection :purge_sample, as: 'purgeSample'
+        end
+      end
+      
       class GoogleCloudRetailV2betaPurgeUserEventsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -941,6 +941,48 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Permanently deletes all selected Products under a branch. This process is
+        # asynchronous. If the request is valid, the removal will be enqueued and
+        # processed offline. Depending on the number of Products, this operation could
+        # take hours to complete. Before the operation completes, some Products may
+        # still be returned by ProductService.GetProduct or ProductService.ListProducts.
+        # Depending on the number of Products, this operation could take hours to
+        # complete. To get a sample of Products that would be deleted, set
+        # PurgeProductsRequest.force to false.
+        # @param [String] parent
+        #   Required. The resource name of the branch under which the products are created.
+        #   The format is `projects/$`projectId`/locations/global/catalogs/$`catalogId`/
+        #   branches/$`branchId``
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PurgeProductsRequest] google_cloud_retail_v2_purge_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::RetailV2::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::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 purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/products:purge', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PurgeProductsRequest::Representation
+          command.request_object = google_cloud_retail_v2_purge_products_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2::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
+        
         # We recommend that you use the ProductService.RemoveLocalInventories method
         # instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.
         # RemoveLocalInventories achieves the same results but provides more fine-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.75.0
+  version: 0.76.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-06-18 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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.75.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.76.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []