algolia 3.22.1 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c57dd38d31a525efb169f39ee223c30334d1f17f4e2e31288e3d47a9385ca0
-  data.tar.gz: 1d8c171978f9ac404996faf0bd3464a9aae3ad89e415c9a1c5d55d06d85ec732
+  metadata.gz: 9fff1502a30fce45ad42d7166299524a573e06053f830fa1f18651e541e4dbdb
+  data.tar.gz: 76b07e570220ca1cb5afd4ce7c82d103f83cc40dbb0a52aeccfdfa341689d4bf
 SHA512:
-  metadata.gz: 23275035d3a2904e2c604ab70e4551b642d78c2f620baf4681454195b95015c72e8e67b2d129965a28d7f6aef33f5d2a6a26dec3e497d83e1bcda1766c6590a9
-  data.tar.gz: 18c62b811bb45a9ed586ed5e0ecff98aedd4d7704ec6dab4fad9b9a5ce73da4893bc8f5bc5f6af9ef8df34ae216fff1f2dcb835e4a504a310b8d6e84f9d59558
+  metadata.gz: c423ef6ca5a1b550eb3f54668e42df002f9e4355e0db592274814e21ea1670660c24a64cce4352580877cd0ace43d623aba790efaacec671e4a5ac3ee9abdb83
+  data.tar.gz: 017a0a4378f8d441486bc6fc9a94b254a0a02d692362bf89c063e4f3f4df1f8e00bf3a4aa4080307477f8444a1760a2d55d65335b8786c2cc80356390f85355d

data/.github/workflows/release.yml

@@ -24,6 +24,6 @@ jobs:
           ruby-version: 3.4.5
           bundler-cache: true
 
-      - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32
+      - uses: rubygems/release-gem@ebe1ec66bd8d2c709ac29aa2b43438d450e7a0a6
         with:
           await-release: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.23.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.22.1...3.23.0)
+
+- [050aacef17](https://github.com/algolia/api-clients-automation/commit/050aacef17) chore(deps): dependencies 2025-07-28 ([#5161](https://github.com/algolia/api-clients-automation/pull/5161)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [66bc4eee9e](https://github.com/algolia/api-clients-automation/commit/66bc4eee9e) feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package ([#5157](https://github.com/algolia/api-clients-automation/pull/5157)) by [@leonardogavaudan](https://github.com/leonardogavaudan/)
+
 ## [3.22.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.22.0...3.22.1)
 
 - [84a1f4e422](https://github.com/algolia/api-clients-automation/commit/84a1f4e422) refactor(specs): add interface to manipulate query parameter between composition API & Search API ([#5123](https://github.com/algolia/api-clients-automation/pull/5123)) by [@ClaraMuller](https://github.com/ClaraMuller/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.22.1)
+    algolia (3.23.0)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/abtesting_v3_client.rb

@@ -0,0 +1,638 @@
+# frozen_string_literal: true
+
+# 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
+  class AbtestingV3Client
+    attr_accessor :api_client
+
+    def initialize(config = nil)
+      raise "`config` is missing." if config.nil?
+      raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
+      raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
+
+      @api_client = Algolia::ApiClient.new(config)
+    end
+
+    def self.create(app_id, api_key, region = nil, opts = {})
+      hosts = []
+      regions = ["de", "us"]
+
+      if region.is_a?(Hash) && (opts.nil? || opts.empty?)
+        opts = region
+        region = nil
+      end
+
+      if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
+        raise "`region` must be one of the following: #{regions.join(", ")}"
+      end
+
+      hosts <<
+        Transport::StatefulHost.new(
+          region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub("{region}", region),
+          accept: CallType::READ | CallType::WRITE
+        )
+
+      config = Algolia::Configuration.new(app_id, api_key, hosts, "AbtestingV3", opts)
+      create_with_config(config)
+    end
+
+    def self.create_with_config(config)
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
+      new(config)
+    end
+
+    # Helper method to switch the API key used to authenticate the requests.
+    #
+    # @param api_key [String] the new API key to use.
+    # @return [void]
+    def set_client_api_key(api_key)
+      @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
+    end
+
+    # Creates a new A/B test.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param add_ab_tests_request [AddABTestsRequest]  (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 add_ab_tests_with_http_info(add_ab_tests_request, request_options = {})
+      # verify the required parameter 'add_ab_tests_request' is set
+      if @api_client.config.client_side_validation && add_ab_tests_request.nil?
+        raise ArgumentError, "Parameter `add_ab_tests_request` is required when calling `add_ab_tests`."
+      end
+
+      path = "/3/abtests"
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(add_ab_tests_request)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.add_ab_tests",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Creates a new A/B test.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param add_ab_tests_request [AddABTestsRequest]  (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 add_ab_tests(add_ab_tests_request, request_options = {})
+      response = add_ab_tests_with_http_info(add_ab_tests_request, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTestResponse")
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @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 custom_delete_with_http_info(path, parameters = nil, request_options = {})
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
+      end
+
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
+      query_params = {}
+      query_params = query_params.merge(parameters) unless parameters.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.custom_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:DELETE, path, new_options)
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @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 [Object]
+    def custom_delete(path, parameters = nil, request_options = {})
+      response = custom_delete_with_http_info(path, parameters, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @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 custom_get_with_http_info(path, parameters = nil, request_options = {})
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
+      end
+
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
+      query_params = {}
+      query_params = query_params.merge(parameters) unless parameters.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.custom_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @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 [Object]
+    def custom_get(path, parameters = nil, request_options = {})
+      response = custom_get_with_http_info(path, parameters, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @param body [Object] Parameters to send with the custom request.
+    # @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 custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
+      end
+
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
+      query_params = {}
+      query_params = query_params.merge(parameters) unless parameters.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.custom_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @param body [Object] Parameters to send with the custom request.
+    # @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 [Object]
+    def custom_post(path, parameters = nil, body = nil, request_options = {})
+      response = custom_post_with_http_info(path, parameters, body, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @param body [Object] Parameters to send with the custom request.
+    # @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 custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
+      end
+
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
+      query_params = {}
+      query_params = query_params.merge(parameters) unless parameters.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.custom_put",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:PUT, path, new_options)
+    end
+
+    # This method lets you send requests to the Algolia REST API.
+
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
+    # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
+    # @param body [Object] Parameters to send with the custom request.
+    # @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 [Object]
+    def custom_put(path, parameters = nil, body = nil, request_options = {})
+      response = custom_put_with_http_info(path, parameters, body, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
+    end
+
+    # Deletes an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @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 = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `delete_ab_test`."
+      end
+
+      path = "/3/abtests/{id}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.delete_ab_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:DELETE, path, new_options)
+    end
+
+    # Deletes an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @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 = {})
+      response = delete_ab_test_with_http_info(id, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTestResponse")
+    end
+
+    # Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @param estimate_ab_test_request [EstimateABTestRequest]  (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 estimate_ab_test_with_http_info(estimate_ab_test_request, request_options = {})
+      # verify the required parameter 'estimate_ab_test_request' is set
+      if @api_client.config.client_side_validation && estimate_ab_test_request.nil?
+        raise ArgumentError, "Parameter `estimate_ab_test_request` is required when calling `estimate_ab_test`."
+      end
+
+      path = "/3/abtests/estimate"
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(estimate_ab_test_request)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.estimate_ab_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @param estimate_ab_test_request [EstimateABTestRequest]  (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 [EstimateABTestResponse]
+    def estimate_ab_test(estimate_ab_test_request, request_options = {})
+      response = estimate_ab_test_with_http_info(estimate_ab_test_request, request_options)
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "AbtestingV3::EstimateABTestResponse"
+      )
+    end
+
+    # Retrieves the details for an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @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 = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `get_ab_test`."
+      end
+
+      path = "/3/abtests/{id}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.get_ab_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # Retrieves the details for an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @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 = {})
+      response = get_ab_test_with_http_info(id, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTest")
+    end
+
+    # Retrieves timeseries for an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @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_timeseries_with_http_info(id, start_date = nil, end_date = nil, metric = nil, request_options = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `get_timeseries`."
+      end
+
+      path = "/3/abtests/{id}/timeseries".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
+      query_params = {}
+      query_params[:startDate] = start_date unless start_date.nil?
+      query_params[:endDate] = end_date unless end_date.nil?
+      query_params[:metric] = @api_client.build_collection_param(metric, :multi) unless metric.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.get_timeseries",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # Retrieves timeseries for an A/B test by its ID.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
+    # @param metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @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 [Timeseries]
+    def get_timeseries(id, start_date = nil, end_date = nil, metric = nil, request_options = {})
+      response = get_timeseries_with_http_info(id, start_date, end_date, metric, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::Timeseries")
+    end
+
+    # 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] 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 direction [Direction] Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.
+    # @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,
+      direction = nil,
+      request_options = {}
+    )
+      path = "/3/abtests"
+      query_params = {}
+      query_params[:offset] = offset unless offset.nil?
+      query_params[:limit] = limit unless limit.nil?
+      query_params[:indexPrefix] = index_prefix unless index_prefix.nil?
+      query_params[:indexSuffix] = index_suffix unless index_suffix.nil?
+      query_params[:direction] = direction unless direction.nil?
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.list_ab_tests",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # 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] 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 direction [Direction] Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.
+    # @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,
+      direction = nil,
+      request_options = {}
+    )
+      response = list_ab_tests_with_http_info(offset, limit, index_prefix, index_suffix, direction, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ListABTestsResponse")
+    end
+
+    # Schedule an A/B test to be started at a later time.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param schedule_ab_tests_request [ScheduleABTestsRequest]  (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 schedule_ab_test_with_http_info(schedule_ab_tests_request, request_options = {})
+      # verify the required parameter 'schedule_ab_tests_request' is set
+      if @api_client.config.client_side_validation && schedule_ab_tests_request.nil?
+        raise ArgumentError, "Parameter `schedule_ab_tests_request` is required when calling `schedule_ab_test`."
+      end
+
+      path = "/3/abtests/schedule"
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(schedule_ab_tests_request)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.schedule_ab_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Schedule an A/B test to be started at a later time.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param schedule_ab_tests_request [ScheduleABTestsRequest]  (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 [ScheduleABTestResponse]
+    def schedule_ab_test(schedule_ab_tests_request, request_options = {})
+      response = schedule_ab_test_with_http_info(schedule_ab_tests_request, request_options)
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "AbtestingV3::ScheduleABTestResponse"
+      )
+    end
+
+    # 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 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 = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `stop_ab_test`."
+      end
+
+      path = "/3/abtests/{id}/stop".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.stop_ab_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # 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 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 = {})
+      response = stop_ab_test_with_http_info(id, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTestResponse")
+    end
+
+  end
+end