algolia 3.0.0.beta.9 → 3.0.0.beta.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fcea9c4cdc2e5fe4b4bbefdd10a24ef88aac0da2032a4637e2d8c7b26637ac5
-  data.tar.gz: 178c675d48ffb5ed60b6432af57d75e033612b4b1f10af4d7b478dd3e30b3886
+  metadata.gz: d7cbf50c75d055b57b0fa11bce17057254adef6028335af00245734751edc19a
+  data.tar.gz: 369df07cdd8f04bb2343803c7623a58daa861f769fe506058259aaddf1aa8694
 SHA512:
-  metadata.gz: 4a2a2f15b69fff7582e8de983d6525403daa1179693b2f0362d576dbc8c34ce75ca13c742874def1ea9788d38feaad376d8c8cd00e8a80671dac157eb430ebd4
-  data.tar.gz: 71e9d8baf51f1a2b67eb684897e289b581259ee5ea28f9bebb6374f7f253af3e8b61d55c2d9ad411fc891be8d8c7e9425659e38b8d65b47f5fc41a9f4315c7c2
+  metadata.gz: 0a4bdd4248cc355064dfa72e9220d8ebc097da6075383373ebad2269e7e320d982f0a2a430692ea35de6fa12e632e7fd404eeee307a00e66f012912918642510
+  data.tar.gz: 6d4cdfbcc8310402a0e26e4a17c45df391f7fa2b4227053853b6c910daa3a95951133c42140f74518358de1efbedcca47851beef796705750ec306b74cf11236

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.0.0.beta.10](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.9...3.0.0.beta.10)
+
+- [280037178](https://github.com/algolia/api-clients-automation/commit/280037178) fix(specs): update shopify feature flags ([#3380](https://github.com/algolia/api-clients-automation/pull/3380)) by [@millotp](https://github.com/millotp/)
+- [a68907d1c](https://github.com/algolia/api-clients-automation/commit/a68907d1c) feat(clients): add api key helper test ([#3338](https://github.com/algolia/api-clients-automation/pull/3338)) by [@Fluf22](https://github.com/Fluf22/)
+- [31ba7f6d0](https://github.com/algolia/api-clients-automation/commit/31ba7f6d0) fix(specs): recommend non required parameters ([#3355](https://github.com/algolia/api-clients-automation/pull/3355)) by [@shortcuts](https://github.com/shortcuts/)
+- [337eea93e](https://github.com/algolia/api-clients-automation/commit/337eea93e) fix(specs): results is required in GetRecommendationsResponse ([#3357](https://github.com/algolia/api-clients-automation/pull/3357)) by [@millotp](https://github.com/millotp/)
+
 ## [3.0.0.beta.9](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.8...3.0.0.beta.9)
 
 - [a009967f6](https://github.com/algolia/api-clients-automation/commit/a009967f6) fix(specs): browse response required properties ([#3348](https://github.com/algolia/api-clients-automation/pull/3348)) by [@millotp](https://github.com/millotp/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.9)
+    algolia (3.0.0.beta.10)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
@@ -12,13 +12,15 @@ GEM
   specs:
     base64 (0.2.0)
     connection_pool (2.4.1)
-    faraday (2.9.0)
+    faraday (2.10.0)
       faraday-net_http (>= 2.0, < 3.2)
+      logger
     faraday-net_http (3.1.0)
       net-http
     faraday-net_http_persistent (2.1.0)
       faraday (~> 2.5)
       net-http-persistent (~> 4.0)
+    logger (1.6.0)
     net-http (0.4.1)
       uri
     net-http-persistent (4.0.2)

data/lib/algolia/api/search_client.rb

@@ -3179,16 +3179,16 @@ module Algolia
 
     # Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
     #
-    # @param operation [String] the `operation` that was done on a `key`.
     # @param key [String] the `key` that has been added, deleted or updated.
+    # @param operation [String] the `operation` that was done on a `key`.
     # @param api_key [Hash] necessary to know if an `update` operation has been processed, compare fields of the response with it.
     # @param max_retries [Integer] the maximum number of retries.
     # @param timeout [Proc] the function to decide how long to wait between retries.
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
     # @return [Http::Response] the last get_api_key response
     def wait_for_api_key(
-      operation,
       key,
+      operation,
       api_key = {},
       max_retries = 50,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
@@ -3198,19 +3198,15 @@ module Algolia
       if operation == "update"
         raise ArgumentError, "`api_key` is required when waiting for an `update` operation." if api_key.nil?
         while retries < max_retries
-          begin
-            updatad_key = get_api_key(key, request_options)
-            updated_key_hash = updatad_key.to_hash
-            equals = true
-            api_key.to_hash.each do |k, v|
-              equals &&= updated_key_hash[k] == v
-            end
-
-            return updatad_key if equals
-          rescue AlgoliaError => e
-            raise e unless e.code == 404
+          updated_key = get_api_key(key, request_options)
+          updated_key_hash = updated_key.to_hash
+          equals = true
+          api_key.to_hash.each do |k, v|
+            equals &&= updated_key_hash[k] == v
           end
 
+          return updated_key if equals
+
           retries += 1
           sleep(timeout.call(retries) / 1000.0)
         end
@@ -3222,8 +3218,12 @@ module Algolia
         begin
           res = get_api_key(key, request_options)
           return res if operation == "add"
-        rescue AlgoliaError => e
-          return res if operation == "delete" && e.code == 404
+        rescue AlgoliaHttpError => e
+          if e.code == 404
+            return nil if operation == "delete"
+          else
+            raise e
+          end
         end
 
         retries += 1

data/lib/algolia/models/ingestion/source_shopify.rb

@@ -6,26 +6,8 @@ require "time"
 module Algolia
   module Ingestion
     class SourceShopify
-      # Whether to index collection IDs.   If your store has `has_collection_search_page` set to true, collection IDs will be indexed even if `collectionIDIndexing` is false.
-      attr_accessor :collection_id_indexing
-
-      # Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.
-      attr_accessor :increase_product_collection_limit
-
-      # Whether to set the default price ratio to 1 if no sale price is present.  The price ratio is determined by the ratio: `sale_price` / `regular_price`. If no sale price is present, the price ratio would be 0. If `defaultPriceRatioAsOne` is true, the price ratio is indexed as 1 instead.
-      attr_accessor :default_price_ratio_as_one
-
-      # Whether to exclude out-of-stock variants when determining the `max_variant_price` and `min_variant_price` attributes.
-      attr_accessor :exclude_oos_variants_for_price_at_trs
-
-      # Whether to include an inventory with every variant for every product record.
-      attr_accessor :include_variants_inventory
-
-      # Whether to include collection IDs and handles in the product records.
-      attr_accessor :has_collection_search_page
-
-      # Whether to convert tags on products to named tags.  To learn more, see [Named tags](https://www.algolia.com/doc/integration/shopify/sending-and-managing-data/named-tags).
-      attr_accessor :product_named_tags
+      # Feature flags for the Shopify source.
+      attr_accessor :feature_flags
 
       # URL of the Shopify store.
       attr_accessor :shop_url
@@ -33,13 +15,7 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :collection_id_indexing => :collectionIDIndexing,
-          :increase_product_collection_limit => :increaseProductCollectionLimit,
-          :default_price_ratio_as_one => :defaultPriceRatioAsOne,
-          :exclude_oos_variants_for_price_at_trs => :excludeOOSVariantsForPriceAtTRS,
-          :include_variants_inventory => :includeVariantsInventory,
-          :has_collection_search_page => :hasCollectionSearchPage,
-          :product_named_tags => :productNamedTags,
+          :feature_flags => :featureFlags,
           :shop_url => :shopURL
         }
       end
@@ -52,13 +28,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :collection_id_indexing => :"Boolean",
-          :increase_product_collection_limit => :"Boolean",
-          :default_price_ratio_as_one => :"Boolean",
-          :exclude_oos_variants_for_price_at_trs => :"Boolean",
-          :include_variants_inventory => :"Boolean",
-          :has_collection_search_page => :"Boolean",
-          :product_named_tags => :"Boolean",
+          :feature_flags => :"Hash<String, Object>",
           :shop_url => :"String"
         }
       end
@@ -101,32 +71,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:collection_id_indexing)
-          self.collection_id_indexing = attributes[:collection_id_indexing]
-        end
-
-        if attributes.key?(:increase_product_collection_limit)
-          self.increase_product_collection_limit = attributes[:increase_product_collection_limit]
-        end
-
-        if attributes.key?(:default_price_ratio_as_one)
-          self.default_price_ratio_as_one = attributes[:default_price_ratio_as_one]
-        end
-
-        if attributes.key?(:exclude_oos_variants_for_price_at_trs)
-          self.exclude_oos_variants_for_price_at_trs = attributes[:exclude_oos_variants_for_price_at_trs]
-        end
-
-        if attributes.key?(:include_variants_inventory)
-          self.include_variants_inventory = attributes[:include_variants_inventory]
-        end
-
-        if attributes.key?(:has_collection_search_page)
-          self.has_collection_search_page = attributes[:has_collection_search_page]
-        end
-
-        if attributes.key?(:product_named_tags)
-          self.product_named_tags = attributes[:product_named_tags]
+        if attributes.key?(:feature_flags)
+          if (value = attributes[:feature_flags]).is_a?(Hash)
+            self.feature_flags = value
+          end
         end
 
         if attributes.key?(:shop_url)
@@ -141,13 +89,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          collection_id_indexing == other.collection_id_indexing &&
-          increase_product_collection_limit == other.increase_product_collection_limit &&
-          default_price_ratio_as_one == other.default_price_ratio_as_one &&
-          exclude_oos_variants_for_price_at_trs == other.exclude_oos_variants_for_price_at_trs &&
-          include_variants_inventory == other.include_variants_inventory &&
-          has_collection_search_page == other.has_collection_search_page &&
-          product_named_tags == other.product_named_tags &&
+          feature_flags == other.feature_flags &&
           shop_url == other.shop_url
       end
 
@@ -160,16 +102,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [
-          collection_id_indexing,
-          increase_product_collection_limit,
-          default_price_ratio_as_one,
-          exclude_oos_variants_for_price_at_trs,
-          include_variants_inventory,
-          has_collection_search_page,
-          product_named_tags,
-          shop_url
-        ].hash
+        [feature_flags, shop_url].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/source_update_shopify.rb

@@ -6,37 +6,13 @@ require "time"
 module Algolia
   module Ingestion
     class SourceUpdateShopify
-      # Whether to index collection IDs.   If your store has `has_collection_search_page` set to true, collection IDs will be indexed even if `collectionIDIndexing` is false.
-      attr_accessor :collection_id_indexing
-
-      # Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.
-      attr_accessor :increase_product_collection_limit
-
-      # Whether to set the default price ratio to 1 if no sale price is present.  The price ratio is determined by the ratio: `sale_price` / `regular_price`. If no sale price is present, the price ratio would be 0. If `defaultPriceRatioAsOne` is true, the price ratio is indexed as 1 instead.
-      attr_accessor :default_price_ratio_as_one
-
-      # Whether to exclude out-of-stock variants when determining the `max_variant_price` and `min_variant_price` attributes.
-      attr_accessor :exclude_oos_variants_for_price_at_trs
-
-      # Whether to include an inventory with every variant for every product record.
-      attr_accessor :include_variants_inventory
-
-      # Whether to include collection IDs and handles in the product records.
-      attr_accessor :has_collection_search_page
-
-      # Whether to convert tags on products to named tags.  To learn more, see [Named tags](https://www.algolia.com/doc/integration/shopify/sending-and-managing-data/named-tags).
-      attr_accessor :product_named_tags
+      # Feature flags for the Shopify source.
+      attr_accessor :feature_flags
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :collection_id_indexing => :collectionIDIndexing,
-          :increase_product_collection_limit => :increaseProductCollectionLimit,
-          :default_price_ratio_as_one => :defaultPriceRatioAsOne,
-          :exclude_oos_variants_for_price_at_trs => :excludeOOSVariantsForPriceAtTRS,
-          :include_variants_inventory => :includeVariantsInventory,
-          :has_collection_search_page => :hasCollectionSearchPage,
-          :product_named_tags => :productNamedTags
+          :feature_flags => :featureFlags
         }
       end
 
@@ -48,13 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :collection_id_indexing => :"Boolean",
-          :increase_product_collection_limit => :"Boolean",
-          :default_price_ratio_as_one => :"Boolean",
-          :exclude_oos_variants_for_price_at_trs => :"Boolean",
-          :include_variants_inventory => :"Boolean",
-          :has_collection_search_page => :"Boolean",
-          :product_named_tags => :"Boolean"
+          :feature_flags => :"Hash<String, Object>"
         }
       end
 
@@ -88,32 +58,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:collection_id_indexing)
-          self.collection_id_indexing = attributes[:collection_id_indexing]
-        end
-
-        if attributes.key?(:increase_product_collection_limit)
-          self.increase_product_collection_limit = attributes[:increase_product_collection_limit]
-        end
-
-        if attributes.key?(:default_price_ratio_as_one)
-          self.default_price_ratio_as_one = attributes[:default_price_ratio_as_one]
-        end
-
-        if attributes.key?(:exclude_oos_variants_for_price_at_trs)
-          self.exclude_oos_variants_for_price_at_trs = attributes[:exclude_oos_variants_for_price_at_trs]
-        end
-
-        if attributes.key?(:include_variants_inventory)
-          self.include_variants_inventory = attributes[:include_variants_inventory]
-        end
-
-        if attributes.key?(:has_collection_search_page)
-          self.has_collection_search_page = attributes[:has_collection_search_page]
-        end
-
-        if attributes.key?(:product_named_tags)
-          self.product_named_tags = attributes[:product_named_tags]
+        if attributes.key?(:feature_flags)
+          if (value = attributes[:feature_flags]).is_a?(Hash)
+            self.feature_flags = value
+          end
         end
       end
 
@@ -122,13 +70,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          collection_id_indexing == other.collection_id_indexing &&
-          increase_product_collection_limit == other.increase_product_collection_limit &&
-          default_price_ratio_as_one == other.default_price_ratio_as_one &&
-          exclude_oos_variants_for_price_at_trs == other.exclude_oos_variants_for_price_at_trs &&
-          include_variants_inventory == other.include_variants_inventory &&
-          has_collection_search_page == other.has_collection_search_page &&
-          product_named_tags == other.product_named_tags
+          feature_flags == other.feature_flags
       end
 
       # @see the `==` method
@@ -140,15 +82,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [
-          collection_id_indexing,
-          increase_product_collection_limit,
-          default_price_ratio_as_one,
-          exclude_oos_variants_for_price_at_trs,
-          include_variants_inventory,
-          has_collection_search_page,
-          product_named_tags
-        ].hash
+        [feature_flags].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/get_recommendations_response.rb

@@ -61,6 +61,8 @@ module Algolia
           if (value = attributes[:results]).is_a?(Array)
             self.results = value
           end
+        else
+          self.results = nil
         end
       end
 

data/lib/algolia/models/recommend/trending_items.rb

@@ -95,14 +95,10 @@ module Algolia
 
         if attributes.key?(:facet_name)
           self.facet_name = attributes[:facet_name]
-        else
-          self.facet_name = nil
         end
 
         if attributes.key?(:facet_value)
           self.facet_value = attributes[:facet_value]
-        else
-          self.facet_value = nil
         end
 
         if attributes.key?(:model)

data/lib/algolia/models/recommend/trending_items_query.rb

@@ -142,14 +142,10 @@ module Algolia
 
         if attributes.key?(:facet_name)
           self.facet_name = attributes[:facet_name]
-        else
-          self.facet_name = nil
         end
 
         if attributes.key?(:facet_value)
           self.facet_value = attributes[:facet_value]
-        else
-          self.facet_value = nil
         end
 
         if attributes.key?(:model)

data/lib/algolia/transport/transport.rb

@@ -68,7 +68,7 @@ module Algolia
           )
           if outcome == FAILURE
             decoded_error = JSON.parse(response.error, :symbolize_names => true)
-            raise Algolia::AlgoliaHttpError.new(decoded_error[:status], decoded_error[:message])
+            raise Algolia::AlgoliaHttpError.new(response.status, decoded_error[:message])
           end
 
           return response unless outcome == RETRY

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.0.0.beta.9".freeze
+  VERSION = "3.0.0.beta.10".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.9
+  version: 3.0.0.beta.10
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday