test_sdk 0.0.4

data/lib/test_sdk/types/company_response.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class CompanyResponse
+    # @return [String]
+    attr_reader :name
+    # @return [String] The domain of the company
+    attr_reader :domain
+    # @return [String] The thumbnail URL of the company
+    attr_reader :thumbnail
+    # @return [Integer]
+    attr_reader :id
+    # @return [DateTime]
+    attr_reader :created_at
+    # @return [DateTime]
+    attr_reader :updated_at
+    # @return [Boolean]
+    attr_reader :is_archived
+    # @return [Integer]
+    attr_reader :group_id
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String]
+    # @param domain [String] The domain of the company
+    # @param thumbnail [String] The thumbnail URL of the company
+    # @param id [Integer]
+    # @param created_at [DateTime]
+    # @param updated_at [DateTime]
+    # @param is_archived [Boolean]
+    # @param group_id [Integer]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::CompanyResponse]
+    def initialize(name:, domain:, id:, group_id:, thumbnail: OMIT, created_at: OMIT, updated_at: OMIT,
+                   is_archived: OMIT, additional_properties: nil)
+      @name = name
+      @domain = domain
+      @thumbnail = thumbnail if thumbnail != OMIT
+      @id = id
+      @created_at = created_at if created_at != OMIT
+      @updated_at = updated_at if updated_at != OMIT
+      @is_archived = is_archived if is_archived != OMIT
+      @group_id = group_id
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "domain": domain,
+        "thumbnail": thumbnail,
+        "id": id,
+        "created_at": created_at,
+        "updated_at": updated_at,
+        "is_archived": is_archived,
+        "group_id": group_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CompanyResponse
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::CompanyResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      domain = parsed_json["domain"]
+      thumbnail = parsed_json["thumbnail"]
+      id = parsed_json["id"]
+      created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updated_at"]) unless parsed_json["updated_at"].nil?)
+      is_archived = parsed_json["is_archived"]
+      group_id = parsed_json["group_id"]
+      new(
+        name: name,
+        domain: domain,
+        thumbnail: thumbnail,
+        id: id,
+        created_at: created_at,
+        updated_at: updated_at,
+        is_archived: is_archived,
+        group_id: group_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CompanyResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.domain.is_a?(String) != false || raise("Passed value for field obj.domain is not the expected type, validation failed.")
+      obj.thumbnail&.is_a?(String) != false || raise("Passed value for field obj.thumbnail is not the expected type, validation failed.")
+      obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      obj.is_archived&.is_a?(Boolean) != false || raise("Passed value for field obj.is_archived is not the expected type, validation failed.")
+      obj.group_id.is_a?(Integer) != false || raise("Passed value for field obj.group_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/concentration_endpoint_cdf_detail.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class ConcentrationEndpointCdfDetail
+    # @return [String] The method used. When 'top_user', the value represents the CDF at the exact
+    #  value of a top user. When 'distribution_quantile', the value represents the CDF
+    #  at an approximately evenly spaced quantile.
+    attr_reader :method
+    # @return [Float] The amount for the CDF.
+    attr_reader :amount
+    # @return [Float] The cumulative distribution function of the users, sorted smallest to largest.
+    #  This evenly weights users by count, and represents (1 - top quantile) of the
+    #  user
+    attr_reader :cdf_users
+    # @return [Float] The cumulative distribution function of the amount, sorted smallest to largest.
+    #  This tells us what percentage of all amount is held by the bottom x% of users.
+    attr_reader :cdf_amount
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param method [String] The method used. When 'top_user', the value represents the CDF at the exact
+    #  value of a top user. When 'distribution_quantile', the value represents the CDF
+    #  at an approximately evenly spaced quantile.
+    # @param amount [Float] The amount for the CDF.
+    # @param cdf_users [Float] The cumulative distribution function of the users, sorted smallest to largest.
+    #  This evenly weights users by count, and represents (1 - top quantile) of the
+    #  user
+    # @param cdf_amount [Float] The cumulative distribution function of the amount, sorted smallest to largest.
+    #  This tells us what percentage of all amount is held by the bottom x% of users.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::ConcentrationEndpointCdfDetail]
+    def initialize(method:, amount:, cdf_users: OMIT, cdf_amount: OMIT, additional_properties: nil)
+      @method = method
+      @amount = amount
+      @cdf_users = cdf_users if cdf_users != OMIT
+      @cdf_amount = cdf_amount if cdf_amount != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "method": method,
+        "amount": amount,
+        "cdf_users": cdf_users,
+        "cdf_amount": cdf_amount
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ConcentrationEndpointCdfDetail
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::ConcentrationEndpointCdfDetail]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      method = parsed_json["method"]
+      amount = parsed_json["amount"]
+      cdf_users = parsed_json["cdf_users"]
+      cdf_amount = parsed_json["cdf_amount"]
+      new(
+        method: method,
+        amount: amount,
+        cdf_users: cdf_users,
+        cdf_amount: cdf_amount,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ConcentrationEndpointCdfDetail to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.method.is_a?(String) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
+      obj.amount.is_a?(Float) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
+      obj.cdf_users&.is_a?(Float) != false || raise("Passed value for field obj.cdf_users is not the expected type, validation failed.")
+      obj.cdf_amount&.is_a?(Float) != false || raise("Passed value for field obj.cdf_amount is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/concentration_endpoint_top_users_detail.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class ConcentrationEndpointTopUsersDetail
+    # @return [String] The user identifier.
+    attr_reader :user_id
+    # @return [Float] The amount for the user.
+    attr_reader :amount
+    # @return [Float] The pdf of the total amount for the user.
+    attr_reader :amount_percent
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param user_id [String] The user identifier.
+    # @param amount [Float] The amount for the user.
+    # @param amount_percent [Float] The pdf of the total amount for the user.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::ConcentrationEndpointTopUsersDetail]
+    def initialize(user_id:, amount:, amount_percent:, additional_properties: nil)
+      @user_id = user_id
+      @amount = amount
+      @amount_percent = amount_percent
+      @additional_properties = additional_properties
+      @_field_set = { "user_id": user_id, "amount": amount, "amount_percent": amount_percent }
+    end
+
+    # Deserialize a JSON object to an instance of ConcentrationEndpointTopUsersDetail
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::ConcentrationEndpointTopUsersDetail]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["user_id"]
+      amount = parsed_json["amount"]
+      amount_percent = parsed_json["amount_percent"]
+      new(
+        user_id: user_id,
+        amount: amount,
+        amount_percent: amount_percent,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ConcentrationEndpointTopUsersDetail to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.amount.is_a?(Float) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
+      obj.amount_percent.is_a?(Float) != false || raise("Passed value for field obj.amount_percent is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/concentration_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "concentration_timeseries_detail"
+require_relative "concentration_endpoint_top_users_detail"
+require_relative "concentration_endpoint_cdf_detail"
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  # A collection of concentration measurements of the amount.
+  #  The "amount" is a generic term for the metric being measured, such as revenue or
+  #  gtv.
+  class ConcentrationResponse
+    # @return [Array<NewDemoApiClient::ConcentrationTimeseriesDetail>] The time series metrics for the concentration of the amount. The top 5, 10, and
+    #  20 users are shown, as well as the top 10% and 20% of users, and some other
+    #  supporting aggregate concentration metrics.
+    attr_reader :time_series_metrics
+    # @return [Array<NewDemoApiClient::ConcentrationEndpointTopUsersDetail>] Detail for the top users at the endpoint. Up to the top 100 users are show.
+    attr_reader :endpoint_top_users
+    # @return [Array<NewDemoApiClient::ConcentrationEndpointCdfDetail>] The detailed cumulative distribution function (CDF). The CDF is presented at the
+    #  top 100 users, and beyond that it is presented at approximately evenly spaced
+    #  quantiles. This approach enables robustness to extremely large user bases. The
+    #  CDF is presented for both users and amount.
+    attr_reader :endpoint_cdf
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param time_series_metrics [Array<NewDemoApiClient::ConcentrationTimeseriesDetail>] The time series metrics for the concentration of the amount. The top 5, 10, and
+    #  20 users are shown, as well as the top 10% and 20% of users, and some other
+    #  supporting aggregate concentration metrics.
+    # @param endpoint_top_users [Array<NewDemoApiClient::ConcentrationEndpointTopUsersDetail>] Detail for the top users at the endpoint. Up to the top 100 users are show.
+    # @param endpoint_cdf [Array<NewDemoApiClient::ConcentrationEndpointCdfDetail>] The detailed cumulative distribution function (CDF). The CDF is presented at the
+    #  top 100 users, and beyond that it is presented at approximately evenly spaced
+    #  quantiles. This approach enables robustness to extremely large user bases. The
+    #  CDF is presented for both users and amount.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::ConcentrationResponse]
+    def initialize(time_series_metrics: OMIT, endpoint_top_users: OMIT, endpoint_cdf: OMIT, additional_properties: nil)
+      @time_series_metrics = time_series_metrics if time_series_metrics != OMIT
+      @endpoint_top_users = endpoint_top_users if endpoint_top_users != OMIT
+      @endpoint_cdf = endpoint_cdf if endpoint_cdf != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "time_series_metrics": time_series_metrics,
+        "endpoint_top_users": endpoint_top_users,
+        "endpoint_cdf": endpoint_cdf
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ConcentrationResponse
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::ConcentrationResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      time_series_metrics = parsed_json["time_series_metrics"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::ConcentrationTimeseriesDetail.from_json(json_object: item)
+      end
+      endpoint_top_users = parsed_json["endpoint_top_users"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::ConcentrationEndpointTopUsersDetail.from_json(json_object: item)
+      end
+      endpoint_cdf = parsed_json["endpoint_cdf"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::ConcentrationEndpointCdfDetail.from_json(json_object: item)
+      end
+      new(
+        time_series_metrics: time_series_metrics,
+        endpoint_top_users: endpoint_top_users,
+        endpoint_cdf: endpoint_cdf,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ConcentrationResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.time_series_metrics&.is_a?(Array) != false || raise("Passed value for field obj.time_series_metrics is not the expected type, validation failed.")
+      obj.endpoint_top_users&.is_a?(Array) != false || raise("Passed value for field obj.endpoint_top_users is not the expected type, validation failed.")
+      obj.endpoint_cdf&.is_a?(Array) != false || raise("Passed value for field obj.endpoint_cdf is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/concentration_timeseries_detail.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class ConcentrationTimeseriesDetail
+    # @return [String] The date of the entry.
+    attr_reader :date
+    # @return [Float] The share of amount in the top 5 users.
+    attr_reader :top5count
+    # @return [Float] The share of amount in the top 10 users.
+    attr_reader :top10count
+    # @return [Float] The share of amount in the top 20 users.
+    attr_reader :top20count
+    # @return [Float] The share of amount in the top 10% of users.
+    attr_reader :top10percent
+    # @return [Float] The share of amount in the top 20% of users.
+    attr_reader :top20percent
+    # @return [Float] The mean amount in the period.
+    attr_reader :mean
+    # @return [Float] The 25th percentile of the amount in the period.
+    attr_reader :p25
+    # @return [Float] The 50th percentile of the amount in the period.
+    attr_reader :median
+    # @return [Float] The 75th percentile of the amount in the period.
+    attr_reader :p75
+    # @return [Float] The 90th percentile of the amount in the period.
+    attr_reader :p90
+    # @return [Float] The ratio of the mean to the median amount in the period.
+    attr_reader :average_to_median
+    # @return [Float] The Gini coefficient of the amount in the period, ranging from 0 to 1.
+    attr_reader :gini_coefficient
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param date [String] The date of the entry.
+    # @param top5count [Float] The share of amount in the top 5 users.
+    # @param top10count [Float] The share of amount in the top 10 users.
+    # @param top20count [Float] The share of amount in the top 20 users.
+    # @param top10percent [Float] The share of amount in the top 10% of users.
+    # @param top20percent [Float] The share of amount in the top 20% of users.
+    # @param mean [Float] The mean amount in the period.
+    # @param p25 [Float] The 25th percentile of the amount in the period.
+    # @param median [Float] The 50th percentile of the amount in the period.
+    # @param p75 [Float] The 75th percentile of the amount in the period.
+    # @param p90 [Float] The 90th percentile of the amount in the period.
+    # @param average_to_median [Float] The ratio of the mean to the median amount in the period.
+    # @param gini_coefficient [Float] The Gini coefficient of the amount in the period, ranging from 0 to 1.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::ConcentrationTimeseriesDetail]
+    def initialize(date:, top5count: OMIT, top10count: OMIT, top20count: OMIT, top10percent: OMIT, top20percent: OMIT,
+                   mean: OMIT, p25: OMIT, median: OMIT, p75: OMIT, p90: OMIT, average_to_median: OMIT, gini_coefficient: OMIT, additional_properties: nil)
+      @date = date
+      @top5count = top5count if top5count != OMIT
+      @top10count = top10count if top10count != OMIT
+      @top20count = top20count if top20count != OMIT
+      @top10percent = top10percent if top10percent != OMIT
+      @top20percent = top20percent if top20percent != OMIT
+      @mean = mean if mean != OMIT
+      @p25 = p25 if p25 != OMIT
+      @median = median if median != OMIT
+      @p75 = p75 if p75 != OMIT
+      @p90 = p90 if p90 != OMIT
+      @average_to_median = average_to_median if average_to_median != OMIT
+      @gini_coefficient = gini_coefficient if gini_coefficient != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "date": date,
+        "top_5_count": top5count,
+        "top_10_count": top10count,
+        "top_20_count": top20count,
+        "top_10_percent": top10percent,
+        "top_20_percent": top20percent,
+        "mean": mean,
+        "p25": p25,
+        "median": median,
+        "p75": p75,
+        "p90": p90,
+        "average_to_median": average_to_median,
+        "gini_coefficient": gini_coefficient
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ConcentrationTimeseriesDetail
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::ConcentrationTimeseriesDetail]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      date = parsed_json["date"]
+      top5count = parsed_json["top_5_count"]
+      top10count = parsed_json["top_10_count"]
+      top20count = parsed_json["top_20_count"]
+      top10percent = parsed_json["top_10_percent"]
+      top20percent = parsed_json["top_20_percent"]
+      mean = parsed_json["mean"]
+      p25 = parsed_json["p25"]
+      median = parsed_json["median"]
+      p75 = parsed_json["p75"]
+      p90 = parsed_json["p90"]
+      average_to_median = parsed_json["average_to_median"]
+      gini_coefficient = parsed_json["gini_coefficient"]
+      new(
+        date: date,
+        top5count: top5count,
+        top10count: top10count,
+        top20count: top20count,
+        top10percent: top10percent,
+        top20percent: top20percent,
+        mean: mean,
+        p25: p25,
+        median: median,
+        p75: p75,
+        p90: p90,
+        average_to_median: average_to_median,
+        gini_coefficient: gini_coefficient,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ConcentrationTimeseriesDetail to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+      obj.top5count&.is_a?(Float) != false || raise("Passed value for field obj.top5count is not the expected type, validation failed.")
+      obj.top10count&.is_a?(Float) != false || raise("Passed value for field obj.top10count is not the expected type, validation failed.")
+      obj.top20count&.is_a?(Float) != false || raise("Passed value for field obj.top20count is not the expected type, validation failed.")
+      obj.top10percent&.is_a?(Float) != false || raise("Passed value for field obj.top10percent is not the expected type, validation failed.")
+      obj.top20percent&.is_a?(Float) != false || raise("Passed value for field obj.top20percent is not the expected type, validation failed.")
+      obj.mean&.is_a?(Float) != false || raise("Passed value for field obj.mean is not the expected type, validation failed.")
+      obj.p25&.is_a?(Float) != false || raise("Passed value for field obj.p25 is not the expected type, validation failed.")
+      obj.median&.is_a?(Float) != false || raise("Passed value for field obj.median is not the expected type, validation failed.")
+      obj.p75&.is_a?(Float) != false || raise("Passed value for field obj.p75 is not the expected type, validation failed.")
+      obj.p90&.is_a?(Float) != false || raise("Passed value for field obj.p90 is not the expected type, validation failed.")
+      obj.average_to_median&.is_a?(Float) != false || raise("Passed value for field obj.average_to_median is not the expected type, validation failed.")
+      obj.gini_coefficient&.is_a?(Float) != false || raise("Passed value for field obj.gini_coefficient is not the expected type, validation failed.")
+    end
+  end
+end