algolia 3.0.0.alpha.16 → 3.0.0.alpha.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9219262c062a3e6099325eac4a7088db4fd8d26b2b0c6e0d2b2af190ef3c67b7
-  data.tar.gz: e3c5251de65dc4034ed58e618a67953e9ff86e86850f81d589fd60c652a145de
+  metadata.gz: ee3c010806ca98c1f64cf944a8f110697c3adefd62466255b6a632862dccc217
+  data.tar.gz: 7772d5cee40c3723a1dfbaff12de1691f6c5db2e4149a8afec0b0e9c4e695112
 SHA512:
-  metadata.gz: 40ddf38e087908c7d8cd2450d283a06938ec833426ee6cddf369f0e9b1f292247ef3a9214a56b0f500a0ca1374e6aa6a842ad8d463ad0542c993797cb6db76b7
-  data.tar.gz: 36c49e72251b45e01bc244eb8dad52a0481e5cdb914426bf4459393cd1224707d6b6d9a5a9fefcf03294b9aefc6e376eadcf177eae3066d59bd893791dbe9284
+  metadata.gz: 42c86265e7ad23499dab2ac75f1b15f7d50133d585bc9065ef55465f47af0244b9e52aa3788a886a3b2f61c586dbc2d50445e2580ee44474dd3493760ddd5343
+  data.tar.gz: 84b2006973c2c3a3994d7ecd780a4d618ae97e17d354bae6d016f28c5f617b78fbba40efc49a9113f6a41b5230555e41d02a359f0bf48f0d77a61445af7a488f

data/.openapi-generator/FILES

@@ -1,168 +1,11 @@
-lib/algolia/api/search_client.rb
-lib/algolia/models/search/acl.rb
-lib/algolia/models/search/action.rb
-lib/algolia/models/search/add_api_key_response.rb
-lib/algolia/models/search/advanced_syntax_features.rb
-lib/algolia/models/search/alternatives_as_exact.rb
-lib/algolia/models/search/anchoring.rb
-lib/algolia/models/search/api_key.rb
-lib/algolia/models/search/api_key_operation.rb
-lib/algolia/models/search/around_precision.rb
-lib/algolia/models/search/around_precision_from_value_inner.rb
-lib/algolia/models/search/around_radius.rb
-lib/algolia/models/search/around_radius_all.rb
-lib/algolia/models/search/assign_user_id_params.rb
-lib/algolia/models/search/attribute_to_update.rb
-lib/algolia/models/search/automatic_facet_filter.rb
-lib/algolia/models/search/automatic_facet_filters.rb
-lib/algolia/models/search/base_get_api_key_response.rb
-lib/algolia/models/search/base_index_settings.rb
-lib/algolia/models/search/base_search_params.rb
-lib/algolia/models/search/base_search_params_without_query.rb
-lib/algolia/models/search/base_search_response.rb
-lib/algolia/models/search/batch_assign_user_ids_params.rb
-lib/algolia/models/search/batch_dictionary_entries_params.rb
-lib/algolia/models/search/batch_dictionary_entries_request.rb
-lib/algolia/models/search/batch_params.rb
-lib/algolia/models/search/batch_request.rb
-lib/algolia/models/search/batch_response.rb
-lib/algolia/models/search/batch_write_params.rb
-lib/algolia/models/search/browse_params.rb
-lib/algolia/models/search/browse_params_object.rb
-lib/algolia/models/search/browse_response.rb
-lib/algolia/models/search/built_in_operation.rb
-lib/algolia/models/search/built_in_operation_type.rb
-lib/algolia/models/search/condition.rb
-lib/algolia/models/search/consequence.rb
-lib/algolia/models/search/consequence_hide.rb
-lib/algolia/models/search/consequence_params.rb
-lib/algolia/models/search/consequence_query.rb
-lib/algolia/models/search/consequence_query_object.rb
-lib/algolia/models/search/created_at_response.rb
-lib/algolia/models/search/cursor.rb
-lib/algolia/models/search/delete_api_key_response.rb
-lib/algolia/models/search/delete_by_params.rb
-lib/algolia/models/search/delete_source_response.rb
-lib/algolia/models/search/deleted_at_response.rb
-lib/algolia/models/search/dictionary_action.rb
-lib/algolia/models/search/dictionary_entry.rb
-lib/algolia/models/search/dictionary_entry_state.rb
-lib/algolia/models/search/dictionary_language.rb
-lib/algolia/models/search/dictionary_settings_params.rb
-lib/algolia/models/search/dictionary_type.rb
-lib/algolia/models/search/distinct.rb
-lib/algolia/models/search/edit.rb
-lib/algolia/models/search/edit_type.rb
-lib/algolia/models/search/error_base.rb
-lib/algolia/models/search/exact_on_single_word_query.rb
-lib/algolia/models/search/exhaustive.rb
-lib/algolia/models/search/facet_filters.rb
-lib/algolia/models/search/facet_hits.rb
-lib/algolia/models/search/facet_ordering.rb
-lib/algolia/models/search/facets.rb
-lib/algolia/models/search/facets_stats.rb
-lib/algolia/models/search/fetched_index.rb
-lib/algolia/models/search/get_api_key_response.rb
-lib/algolia/models/search/get_dictionary_settings_response.rb
-lib/algolia/models/search/get_logs_response.rb
-lib/algolia/models/search/get_objects_params.rb
-lib/algolia/models/search/get_objects_request.rb
-lib/algolia/models/search/get_objects_response.rb
-lib/algolia/models/search/get_task_response.rb
-lib/algolia/models/search/get_top_user_ids_response.rb
-lib/algolia/models/search/has_pending_mappings_response.rb
-lib/algolia/models/search/highlight_result.rb
-lib/algolia/models/search/highlight_result_option.rb
-lib/algolia/models/search/hit.rb
-lib/algolia/models/search/ignore_plurals.rb
-lib/algolia/models/search/index_settings.rb
-lib/algolia/models/search/index_settings_as_search_params.rb
-lib/algolia/models/search/languages.rb
-lib/algolia/models/search/list_api_keys_response.rb
-lib/algolia/models/search/list_clusters_response.rb
-lib/algolia/models/search/list_indices_response.rb
-lib/algolia/models/search/list_user_ids_response.rb
-lib/algolia/models/search/log.rb
-lib/algolia/models/search/log_query.rb
-lib/algolia/models/search/log_type.rb
-lib/algolia/models/search/match_level.rb
-lib/algolia/models/search/matched_geo_location.rb
-lib/algolia/models/search/mixed_search_filters.rb
-lib/algolia/models/search/mode.rb
-lib/algolia/models/search/multiple_batch_request.rb
-lib/algolia/models/search/multiple_batch_response.rb
-lib/algolia/models/search/numeric_filters.rb
-lib/algolia/models/search/operation_index_params.rb
-lib/algolia/models/search/operation_type.rb
-lib/algolia/models/search/optional_filters.rb
-lib/algolia/models/search/params.rb
-lib/algolia/models/search/personalization.rb
-lib/algolia/models/search/promote.rb
-lib/algolia/models/search/promote_object_id.rb
-lib/algolia/models/search/promote_object_ids.rb
-lib/algolia/models/search/query_type.rb
-lib/algolia/models/search/ranking_info.rb
-lib/algolia/models/search/re_ranking_apply_filter.rb
-lib/algolia/models/search/redirect.rb
-lib/algolia/models/search/redirect_rule_index_metadata.rb
-lib/algolia/models/search/redirect_rule_index_metadata_data.rb
-lib/algolia/models/search/remove_stop_words.rb
-lib/algolia/models/search/remove_user_id_response.rb
-lib/algolia/models/search/remove_words_if_no_results.rb
-lib/algolia/models/search/rendering_content.rb
-lib/algolia/models/search/replace_source_response.rb
-lib/algolia/models/search/rule.rb
-lib/algolia/models/search/save_object_response.rb
-lib/algolia/models/search/save_synonym_response.rb
-lib/algolia/models/search/scope_type.rb
-lib/algolia/models/search/search_dictionary_entries_params.rb
-lib/algolia/models/search/search_dictionary_entries_response.rb
-lib/algolia/models/search/search_for_facet_values_request.rb
-lib/algolia/models/search/search_for_facet_values_response.rb
-lib/algolia/models/search/search_for_facets.rb
-lib/algolia/models/search/search_for_facets_options.rb
-lib/algolia/models/search/search_for_hits.rb
-lib/algolia/models/search/search_for_hits_options.rb
-lib/algolia/models/search/search_hits.rb
-lib/algolia/models/search/search_method_params.rb
-lib/algolia/models/search/search_params.rb
-lib/algolia/models/search/search_params_object.rb
-lib/algolia/models/search/search_params_query.rb
-lib/algolia/models/search/search_params_string.rb
-lib/algolia/models/search/search_query.rb
-lib/algolia/models/search/search_response.rb
-lib/algolia/models/search/search_responses.rb
-lib/algolia/models/search/search_result.rb
-lib/algolia/models/search/search_rules_params.rb
-lib/algolia/models/search/search_rules_response.rb
-lib/algolia/models/search/search_strategy.rb
-lib/algolia/models/search/search_synonyms_params.rb
-lib/algolia/models/search/search_synonyms_response.rb
-lib/algolia/models/search/search_type_default.rb
-lib/algolia/models/search/search_type_facet.rb
-lib/algolia/models/search/search_user_ids_params.rb
-lib/algolia/models/search/search_user_ids_response.rb
-lib/algolia/models/search/secured_api_key_restrictions.rb
-lib/algolia/models/search/semantic_search.rb
-lib/algolia/models/search/snippet_result.rb
-lib/algolia/models/search/snippet_result_option.rb
-lib/algolia/models/search/sort_remaining_by.rb
-lib/algolia/models/search/source.rb
-lib/algolia/models/search/standard_entries.rb
-lib/algolia/models/search/supported_language.rb
-lib/algolia/models/search/synonym_hit.rb
-lib/algolia/models/search/synonym_type.rb
-lib/algolia/models/search/tag_filters.rb
-lib/algolia/models/search/task_status.rb
-lib/algolia/models/search/time_range.rb
-lib/algolia/models/search/typo_tolerance.rb
-lib/algolia/models/search/typo_tolerance_enum.rb
-lib/algolia/models/search/update_api_key_response.rb
-lib/algolia/models/search/updated_at_response.rb
-lib/algolia/models/search/updated_at_with_object_id_response.rb
-lib/algolia/models/search/updated_rule_response.rb
-lib/algolia/models/search/user_highlight_result.rb
-lib/algolia/models/search/user_hit.rb
-lib/algolia/models/search/user_id.rb
-lib/algolia/models/search/value.rb
+lib/algolia/api/usage_client.rb
+lib/algolia/models/usage/error_base.rb
+lib/algolia/models/usage/get_usage200_response.rb
+lib/algolia/models/usage/get_usage200_response_statistics_inner.rb
+lib/algolia/models/usage/get_usage400_response.rb
+lib/algolia/models/usage/get_usage400_response_error.rb
+lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb
+lib/algolia/models/usage/granularity.rb
+lib/algolia/models/usage/statistic.rb
+lib/algolia/models/usage/statistic_value.rb
 lib/algolia/version.rb

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [3.0.0.alpha.18](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.17...3.0.0.alpha.18)
+
+- [41121e77e](https://github.com/algolia/api-clients-automation/commit/41121e77e) fix(specs): attribute and index names case sensitive ([#2990](https://github.com/algolia/api-clients-automation/pull/2990)) by [@kai687](https://github.com/kai687/)
+- [67b0eab89](https://github.com/algolia/api-clients-automation/commit/67b0eab89) feat(specs): update shopify source and task inputs ([#2987](https://github.com/algolia/api-clients-automation/pull/2987)) by [@Fluf22](https://github.com/Fluf22/)
+- [60e8e6d68](https://github.com/algolia/api-clients-automation/commit/60e8e6d68) fix(specs): Personalization API ([#2982](https://github.com/algolia/api-clients-automation/pull/2982)) by [@kai687](https://github.com/kai687/)
+- [60322c0b5](https://github.com/algolia/api-clients-automation/commit/60322c0b5) fix(specs): a/b testing ([#2981](https://github.com/algolia/api-clients-automation/pull/2981)) by [@kai687](https://github.com/kai687/)
+
+## [3.0.0.alpha.17](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.16...3.0.0.alpha.17)
+
+- [dabdd0291](https://github.com/algolia/api-clients-automation/commit/dabdd0291) fix(specs): recommend api ([#2958](https://github.com/algolia/api-clients-automation/pull/2958)) by [@kai687](https://github.com/kai687/)
+- [34e345d48](https://github.com/algolia/api-clients-automation/commit/34e345d48) fix(specs): update documentation for consistency ([#2976](https://github.com/algolia/api-clients-automation/pull/2976)) by [@kai687](https://github.com/kai687/)
+- [aee3fde96](https://github.com/algolia/api-clients-automation/commit/aee3fde96) feat(clients): add `usage` client ([#2960](https://github.com/algolia/api-clients-automation/pull/2960)) by [@shortcuts](https://github.com/shortcuts/)
+- [0348669d0](https://github.com/algolia/api-clients-automation/commit/0348669d0) feat(specs): add algoliaInsights auth type ([#2959](https://github.com/algolia/api-clients-automation/pull/2959)) by [@jkaho](https://github.com/jkaho/)
+- [60e23f87a](https://github.com/algolia/api-clients-automation/commit/60e23f87a) fix(specs): usage api ([#2954](https://github.com/algolia/api-clients-automation/pull/2954)) by [@kai687](https://github.com/kai687/)
+- [3e0d0dcc2](https://github.com/algolia/api-clients-automation/commit/3e0d0dcc2) fix(specs): crawler api ([#2949](https://github.com/algolia/api-clients-automation/pull/2949)) by [@kai687](https://github.com/kai687/)
+
 ## [3.0.0.alpha.16](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.15...3.0.0.alpha.16)
 
 - [10e08c9e7](https://github.com/algolia/api-clients-automation/commit/10e08c9e7) fix(specs): query suggestions api ([#2924](https://github.com/algolia/api-clients-automation/pull/2924)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.alpha.16)
+    algolia (3.0.0.alpha.18)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent
@@ -18,7 +18,7 @@ GEM
     faraday-net_http_persistent (2.1.0)
       faraday (~> 2.5)
       net-http-persistent (~> 4.0)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     net-http (0.4.1)
       uri
@@ -30,10 +30,10 @@ GEM
       racc
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.62.1)
+    rubocop (1.63.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)

data/lib/algolia/api/abtesting_client.rb

@@ -34,7 +34,7 @@ module Algolia
       new(config)
     end
 
-    # Creates an A/B test.
+    # Creates a new A/B test.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -66,7 +66,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Creates an A/B test.
+    # Creates a new A/B test.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -254,11 +254,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Deletes an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
     def delete_ab_test_with_http_info(id, request_options = {})
@@ -286,11 +286,11 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Deletes an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [ABTestResponse]
     def delete_ab_test(id, request_options = {})
@@ -298,11 +298,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
     end
 
-    # Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Retrieves the details for an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - analytics
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
     def get_ab_test_with_http_info(id, request_options = {})
@@ -330,11 +330,11 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Retrieves the details for an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - analytics
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [ABTest]
     def get_ab_test(id, request_options = {})
@@ -342,14 +342,14 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTest')
     end
 
-    # List all A/B tests.
+    # Lists all A/B tests you configured for this application.
     #
     # Required API Key ACLs:
     #   - analytics
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @param limit [Integer] Number of items to return. (default to 10)
-    # @param index_prefix [String] Only return A/B tests for indices starting with this prefix.
-    # @param index_suffix [String] Only return A/B tests for indices ending with this suffix.
+    # @param index_prefix [String] Index name prefix. Only A/B tests for indices starting with this string are included in the response.
+    # @param index_suffix [String] Index name suffix. Only A/B tests for indices ending with this string are included in the response.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
     def list_ab_tests_with_http_info(offset = nil, limit = nil, index_prefix = nil, index_suffix = nil, request_options = {})
@@ -380,14 +380,14 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List all A/B tests.
+    # Lists all A/B tests you configured for this application.
     #
     # Required API Key ACLs:
     #   - analytics
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @param limit [Integer] Number of items to return. (default to 10)
-    # @param index_prefix [String] Only return A/B tests for indices starting with this prefix.
-    # @param index_suffix [String] Only return A/B tests for indices ending with this suffix.
+    # @param index_prefix [String] Index name prefix. Only A/B tests for indices starting with this string are included in the response.
+    # @param index_suffix [String] Index name suffix. Only A/B tests for indices ending with this string are included in the response.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [ListABTestsResponse]
     def list_ab_tests(offset = nil, limit = nil, index_prefix = nil, index_suffix = nil, request_options = {})
@@ -395,11 +395,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ListABTestsResponse')
     end
 
-    # If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
     def stop_ab_test_with_http_info(id, request_options = {})
@@ -427,11 +427,11 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+    # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs:
     #   - editSettings
-    # @param id [Integer] Unique A/B test ID. (required)
+    # @param id [Integer] Unique A/B test identifier. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [ABTestResponse]
     def stop_ab_test(id, request_options = {})