test_sdk 0.0.4

data/lib/test_sdk/benchmark/client.rb

@@ -0,0 +1,1031 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/available_categories_response"
+require "json"
+require_relative "../types/benchmark_quantile"
+require_relative "../types/scale_models_response"
+require_relative "../types/available_models_response"
+require_relative "../types/tradeoff_models_response"
+require_relative "../types/user_type"
+require_relative "../types/deal_combined_metrics_response"
+require_relative "../types/columns_metadata_response"
+require_relative "../types/models_metadata_response"
+require_relative "../types/categories_metadata_response"
+require "async"
+
+module NewDemoApiClient
+  class BenchmarkClient
+    # @return [NewDemoApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::RequestClient]
+    # @return [NewDemoApiClient::BenchmarkClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get the list of categories with benchmark models available for the account.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AVAILABLE_CATEGORIES_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_benchmark_categories(group_id: 1)
+    def get_available_benchmark_categories(group_id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/available-benchmark-categories"
+      end
+      JSON.parse(response.body)
+    end
+
+    # Get the benchmark quantiles for a given category at a specified revenue scale.
+    #  If columns are specified, only those columns will be returned.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param revenue [Float] Annualized revenue scale for which to obtain benchmarks
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::BenchmarkQuantile>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_quantiles(
+    #    group_id: 1,
+    #    category: "category",
+    #    revenue: 1.1
+    #  )
+    def get_quantiles(group_id:, category:, revenue:, column: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "revenue": revenue,
+          "column": column
+        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/quantiles/#{category}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::BenchmarkQuantile.from_json(json_object: item)
+      end
+    end
+
+    # Get the scaling models for a given category. Multiple models can be specified.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::SCALE_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_scaling(group_id: 1, category: "category")
+    def get_scaling(group_id:, category:, model: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "model": model }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/scaling/#{category}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.transform_values do |value|
+        value = value.to_json
+        NewDemoApiClient::ScaleModel.from_json(json_object: value)
+      end
+    end
+
+    # Get the list of available scaling and tradeoff models for the account.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AvailableModelsResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_models(group_id: 1)
+    def get_available_models(group_id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/available-models"
+      end
+      NewDemoApiClient::AvailableModelsResponse.from_json(json_object: response.body)
+    end
+
+    # Get the tradeoff at scale model for a given category.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param revenue [Float] Annualized revenue scale for which to obtain benchmarks
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::TRADEOFF_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_tradeoff_at_scale(
+    #    group_id: 1,
+    #    category: "category",
+    #    revenue: 1.1
+    #  )
+    def get_tradeoff_at_scale(group_id:, category:, revenue:, model: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "revenue": revenue,
+          "model": model
+        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/tradeoff-at-scale/#{category}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.transform_values do |value|
+        value = value.to_json
+        NewDemoApiClient::TradeoffModel.from_json(json_object: value)
+      end
+    end
+
+    # Get the categories with benchmark models available for the company associated
+    #  with the deal.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AVAILABLE_CATEGORIES_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_company_categories(group_id: 1, deal_id: 1)
+    def get_available_company_categories(group_id:, deal_id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/available-categories"
+      end
+      JSON.parse(response.body)
+    end
+
+    # Get the combined time series data for the deal.
+    #
+    # @param user_type [NewDemoApiClient::UserType]
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::DealCombinedMetricsResponse>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_combined_time_series(
+    #    user_type: BUSINESS,
+    #    group_id: 1,
+    #    deal_id: 1
+    #  )
+    def get_combined_time_series(user_type:, group_id:, deal_id:, column: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{user_type}/deal/#{group_id}/data/benchmark/combined-time-series/#{deal_id}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::DealCombinedMetricsResponse.from_json(json_object: item)
+      end
+    end
+
+    # Get the time series data endpoint for the deal.
+    #
+    # @param user_type [NewDemoApiClient::UserType]
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::DealCombinedMetricsResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_time_series_endpoint(
+    #    user_type: BUSINESS,
+    #    group_id: 1,
+    #    deal_id: 1
+    #  )
+    def get_time_series_endpoint(user_type:, group_id:, deal_id:, column: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{user_type}/deal/#{group_id}/data/benchmark/time-series-endpoint/#{deal_id}"
+      end
+      NewDemoApiClient::DealCombinedMetricsResponse.from_json(json_object: response.body)
+    end
+
+    # Get the benchmark quantiles for a given category.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param category [String]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::BenchmarkQuantile>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_deal_benchmark_quantiles(
+    #    group_id: 1,
+    #    deal_id: 1,
+    #    category: "category"
+    #  )
+    def get_deal_benchmark_quantiles(group_id:, deal_id:, category:, column: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/quantiles/#{category}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::BenchmarkQuantile.from_json(json_object: item)
+      end
+    end
+
+    # Get the tradeoff models for a given category.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param category [String]
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::TRADEOFF_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_deal_benchmark_tradeoff_at_scale(
+    #    group_id: 1,
+    #    deal_id: 1,
+    #    category: "category"
+    #  )
+    def get_deal_benchmark_tradeoff_at_scale(group_id:, deal_id:, category:, model: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "model": model }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/tradeoff-at-scale/#{category}"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.transform_values do |value|
+        value = value.to_json
+        NewDemoApiClient::TradeoffModel.from_json(json_object: value)
+      end
+    end
+
+    # Get the columns metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::ColumnsMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_columns_metadata
+    def get_columns_metadata(request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/columns"
+      end
+      NewDemoApiClient::ColumnsMetadataResponse.from_json(json_object: response.body)
+    end
+
+    # Get the models metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::ModelsMetadataResponse>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_models_metadata
+    def get_models_metadata(request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/models"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::ModelsMetadataResponse.from_json(json_object: item)
+      end
+    end
+
+    # Get the categories metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::CategoriesMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_categories_metadata
+    def get_categories_metadata(request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/categories"
+      end
+      NewDemoApiClient::CategoriesMetadataResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncBenchmarkClient
+    # @return [NewDemoApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::AsyncRequestClient]
+    # @return [NewDemoApiClient::AsyncBenchmarkClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Get the list of categories with benchmark models available for the account.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AVAILABLE_CATEGORIES_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_benchmark_categories(group_id: 1)
+    def get_available_benchmark_categories(group_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/available-benchmark-categories"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json
+      end
+    end
+
+    # Get the benchmark quantiles for a given category at a specified revenue scale.
+    #  If columns are specified, only those columns will be returned.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param revenue [Float] Annualized revenue scale for which to obtain benchmarks
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::BenchmarkQuantile>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_quantiles(
+    #    group_id: 1,
+    #    category: "category",
+    #    revenue: 1.1
+    #  )
+    def get_quantiles(group_id:, category:, revenue:, column: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "revenue": revenue,
+            "column": column
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/quantiles/#{category}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::BenchmarkQuantile.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get the scaling models for a given category. Multiple models can be specified.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::SCALE_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_scaling(group_id: 1, category: "category")
+    def get_scaling(group_id:, category:, model: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "model": model }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/scaling/#{category}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.transform_values do |value|
+          value = value.to_json
+          NewDemoApiClient::ScaleModel.from_json(json_object: value)
+        end
+      end
+    end
+
+    # Get the list of available scaling and tradeoff models for the account.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AvailableModelsResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_models(group_id: 1)
+    def get_available_models(group_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/available-models"
+        end
+        NewDemoApiClient::AvailableModelsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get the tradeoff at scale model for a given category.
+    #
+    # @param group_id [Integer]
+    # @param category [String]
+    # @param revenue [Float] Annualized revenue scale for which to obtain benchmarks
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::TRADEOFF_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_tradeoff_at_scale(
+    #    group_id: 1,
+    #    category: "category",
+    #    revenue: 1.1
+    #  )
+    def get_tradeoff_at_scale(group_id:, category:, revenue:, model: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "revenue": revenue,
+            "model": model
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/data/benchmark/tradeoff-at-scale/#{category}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.transform_values do |value|
+          value = value.to_json
+          NewDemoApiClient::TradeoffModel.from_json(json_object: value)
+        end
+      end
+    end
+
+    # Get the categories with benchmark models available for the company associated
+    #  with the deal.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AVAILABLE_CATEGORIES_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_available_company_categories(group_id: 1, deal_id: 1)
+    def get_available_company_categories(group_id:, deal_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/available-categories"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json
+      end
+    end
+
+    # Get the combined time series data for the deal.
+    #
+    # @param user_type [NewDemoApiClient::UserType]
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::DealCombinedMetricsResponse>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_combined_time_series(
+    #    user_type: BUSINESS,
+    #    group_id: 1,
+    #    deal_id: 1
+    #  )
+    def get_combined_time_series(user_type:, group_id:, deal_id:, column: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{user_type}/deal/#{group_id}/data/benchmark/combined-time-series/#{deal_id}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::DealCombinedMetricsResponse.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get the time series data endpoint for the deal.
+    #
+    # @param user_type [NewDemoApiClient::UserType]
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::DealCombinedMetricsResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_time_series_endpoint(
+    #    user_type: BUSINESS,
+    #    group_id: 1,
+    #    deal_id: 1
+    #  )
+    def get_time_series_endpoint(user_type:, group_id:, deal_id:, column: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{user_type}/deal/#{group_id}/data/benchmark/time-series-endpoint/#{deal_id}"
+        end
+        NewDemoApiClient::DealCombinedMetricsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get the benchmark quantiles for a given category.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param category [String]
+    # @param column [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::BenchmarkQuantile>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_deal_benchmark_quantiles(
+    #    group_id: 1,
+    #    deal_id: 1,
+    #    category: "category"
+    #  )
+    def get_deal_benchmark_quantiles(group_id:, deal_id:, category:, column: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "column": column }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/quantiles/#{category}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::BenchmarkQuantile.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get the tradeoff models for a given category.
+    #
+    # @param group_id [Integer]
+    # @param deal_id [Integer]
+    # @param category [String]
+    # @param model [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::TRADEOFF_MODELS_RESPONSE]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_deal_benchmark_tradeoff_at_scale(
+    #    group_id: 1,
+    #    deal_id: 1,
+    #    category: "category"
+    #  )
+    def get_deal_benchmark_tradeoff_at_scale(group_id:, deal_id:, category:, model: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "model": model }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/group/#{group_id}/deal/#{deal_id}/data/benchmark/tradeoff-at-scale/#{category}"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.transform_values do |value|
+          value = value.to_json
+          NewDemoApiClient::TradeoffModel.from_json(json_object: value)
+        end
+      end
+    end
+
+    # Get the columns metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::ColumnsMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_columns_metadata
+    def get_columns_metadata(request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/columns"
+        end
+        NewDemoApiClient::ColumnsMetadataResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get the models metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::ModelsMetadataResponse>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_models_metadata
+    def get_models_metadata(request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/models"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::ModelsMetadataResponse.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get the categories metadata.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::CategoriesMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.benchmark.get_categories_metadata
+    def get_categories_metadata(request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/api/v1/data/benchmark/metadata/categories"
+        end
+        NewDemoApiClient::CategoriesMetadataResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end