trophy_api_client 1.0.36 → 1.0.38

data/lib/trophy_api_client/types/wrapped_activity_period.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "completed_achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Activity data for a specific period (day, week, month, or year).
+  class WrappedActivityPeriod
+    # @return [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    attr_reader :metrics
+    # @return [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    attr_reader :points
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    attr_reader :achievements
+    # @return [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    attr_reader :leaderboards
+    # @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 metrics [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    # @param points [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    # @param leaderboards [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedActivityPeriod]
+    def initialize(metrics:, points:, achievements:, leaderboards:, additional_properties: nil)
+      @metrics = metrics
+      @points = points
+      @achievements = achievements
+      @leaderboards = leaderboards
+      @additional_properties = additional_properties
+      @_field_set = { "metrics": metrics, "points": points, "achievements": achievements, "leaderboards": leaderboards }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedActivityPeriod
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedActivityPeriod]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      metrics = parsed_json["metrics"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedMetric.from_json(json_object: value)
+      end
+      points = parsed_json["points"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedPoints.from_json(json_object: value)
+      end
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
+      end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: value)
+      end
+      new(
+        metrics: metrics,
+        points: points,
+        achievements: achievements,
+        leaderboards: leaderboards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedActivityPeriod 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.metrics.is_a?(Hash) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.leaderboards.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_entire_year.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "wrapped_streak"
+require_relative "completed_achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's activity data for the entire year.
+  class WrappedEntireYear
+    # @return [TrophyApiClient::WrappedStreak] The user's longest streak during the year.
+    attr_reader :longest_streak
+    # @return [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    attr_reader :metrics
+    # @return [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    attr_reader :points
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    attr_reader :achievements
+    # @return [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    attr_reader :leaderboards
+    # @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 longest_streak [TrophyApiClient::WrappedStreak] The user's longest streak during the year.
+    # @param metrics [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    # @param points [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    # @param leaderboards [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedEntireYear]
+    def initialize(longest_streak:, metrics:, points:, achievements:, leaderboards:, additional_properties: nil)
+      @longest_streak = longest_streak
+      @metrics = metrics
+      @points = points
+      @achievements = achievements
+      @leaderboards = leaderboards
+      @additional_properties = additional_properties
+      @_field_set = {
+        "longestStreak": longest_streak,
+        "metrics": metrics,
+        "points": points,
+        "achievements": achievements,
+        "leaderboards": leaderboards
+      }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedEntireYear
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedEntireYear]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["longestStreak"].nil?
+        longest_streak = nil
+      else
+        longest_streak = parsed_json["longestStreak"].to_json
+        longest_streak = TrophyApiClient::WrappedStreak.from_json(json_object: longest_streak)
+      end
+      metrics = parsed_json["metrics"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedMetric.from_json(json_object: value)
+      end
+      points = parsed_json["points"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedPoints.from_json(json_object: value)
+      end
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
+      end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: value)
+      end
+      new(
+        longest_streak: longest_streak,
+        metrics: metrics,
+        points: points,
+        achievements: achievements,
+        leaderboards: leaderboards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedEntireYear 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:)
+      TrophyApiClient::WrappedStreak.validate_raw(obj: obj.longest_streak)
+      obj.metrics.is_a?(Hash) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.leaderboards.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_metric.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's metric data for a wrapped period.
+  class WrappedMetric
+    # @return [String] The name of the metric.
+    attr_reader :name
+    # @return [String] The units of the metric.
+    attr_reader :units
+    # @return [Float] The user's current total for the metric.
+    attr_reader :current_total
+    # @return [Float] The change in the metric value during the period.
+    attr_reader :change_this_period
+    # @return [Float] The percentage change in the metric value during the period.
+    attr_reader :percent_change
+    # @return [Float] The user's percentile rank for this metric during the period. Only included for
+    #  weekly, monthly, and yearly aggregation periods.
+    attr_reader :percentile_this_period
+    # @return [Hash{String => Hash}] Metric data broken down by attribute key and value.
+    attr_reader :by_attribute
+    # @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] The name of the metric.
+    # @param units [String] The units of the metric.
+    # @param current_total [Float] The user's current total for the metric.
+    # @param change_this_period [Float] The change in the metric value during the period.
+    # @param percent_change [Float] The percentage change in the metric value during the period.
+    # @param percentile_this_period [Float] The user's percentile rank for this metric during the period. Only included for
+    #  weekly, monthly, and yearly aggregation periods.
+    # @param by_attribute [Hash{String => Hash}] Metric data broken down by attribute key and value.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedMetric]
+    def initialize(name:, current_total:, change_this_period:, percent_change:, by_attribute:, units: OMIT,
+                   percentile_this_period: OMIT, additional_properties: nil)
+      @name = name
+      @units = units if units != OMIT
+      @current_total = current_total
+      @change_this_period = change_this_period
+      @percent_change = percent_change
+      @percentile_this_period = percentile_this_period if percentile_this_period != OMIT
+      @by_attribute = by_attribute
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "units": units,
+        "currentTotal": current_total,
+        "changeThisPeriod": change_this_period,
+        "percentChange": percent_change,
+        "percentileThisPeriod": percentile_this_period,
+        "byAttribute": by_attribute
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WrappedMetric
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedMetric]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      units = parsed_json["units"]
+      current_total = parsed_json["currentTotal"]
+      change_this_period = parsed_json["changeThisPeriod"]
+      percent_change = parsed_json["percentChange"]
+      percentile_this_period = parsed_json["percentileThisPeriod"]
+      by_attribute = parsed_json["byAttribute"]&.transform_values do |value|
+        value&.transform_values do |value|
+          value = value.to_json
+          TrophyApiClient::WrappedMetricByAttributeValueValue.from_json(json_object: value)
+        end
+      end
+      new(
+        name: name,
+        units: units,
+        current_total: current_total,
+        change_this_period: change_this_period,
+        percent_change: percent_change,
+        percentile_this_period: percentile_this_period,
+        by_attribute: by_attribute,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedMetric 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.units&.is_a?(String) != false || raise("Passed value for field obj.units is not the expected type, validation failed.")
+      obj.current_total.is_a?(Float) != false || raise("Passed value for field obj.current_total is not the expected type, validation failed.")
+      obj.change_this_period.is_a?(Float) != false || raise("Passed value for field obj.change_this_period is not the expected type, validation failed.")
+      obj.percent_change.is_a?(Float) != false || raise("Passed value for field obj.percent_change is not the expected type, validation failed.")
+      obj.percentile_this_period&.is_a?(Float) != false || raise("Passed value for field obj.percentile_this_period is not the expected type, validation failed.")
+      obj.by_attribute.is_a?(Hash) != false || raise("Passed value for field obj.by_attribute is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_metric_by_attribute_value_value.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WrappedMetricByAttributeValueValue
+    # @return [String] The name of the metric.
+    attr_reader :name
+    # @return [String] The units of the metric.
+    attr_reader :units
+    # @return [Float] The current total for this attribute value.
+    attr_reader :current_total
+    # @return [Float] The change during the period for this attribute value.
+    attr_reader :change_this_period
+    # @return [Float] The percentage change for this attribute value.
+    attr_reader :percent_change
+    # @return [Float] The user's percentile rank for this attribute value during the period.
+    attr_reader :percentile_this_period
+    # @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] The name of the metric.
+    # @param units [String] The units of the metric.
+    # @param current_total [Float] The current total for this attribute value.
+    # @param change_this_period [Float] The change during the period for this attribute value.
+    # @param percent_change [Float] The percentage change for this attribute value.
+    # @param percentile_this_period [Float] The user's percentile rank for this attribute value during the period.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedMetricByAttributeValueValue]
+    def initialize(name: OMIT, units: OMIT, current_total: OMIT, change_this_period: OMIT, percent_change: OMIT,
+                   percentile_this_period: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @units = units if units != OMIT
+      @current_total = current_total if current_total != OMIT
+      @change_this_period = change_this_period if change_this_period != OMIT
+      @percent_change = percent_change if percent_change != OMIT
+      @percentile_this_period = percentile_this_period if percentile_this_period != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "units": units,
+        "currentTotal": current_total,
+        "changeThisPeriod": change_this_period,
+        "percentChange": percent_change,
+        "percentileThisPeriod": percentile_this_period
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WrappedMetricByAttributeValueValue
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedMetricByAttributeValueValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      units = parsed_json["units"]
+      current_total = parsed_json["currentTotal"]
+      change_this_period = parsed_json["changeThisPeriod"]
+      percent_change = parsed_json["percentChange"]
+      percentile_this_period = parsed_json["percentileThisPeriod"]
+      new(
+        name: name,
+        units: units,
+        current_total: current_total,
+        change_this_period: change_this_period,
+        percent_change: percent_change,
+        percentile_this_period: percentile_this_period,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedMetricByAttributeValueValue 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.units&.is_a?(String) != false || raise("Passed value for field obj.units is not the expected type, validation failed.")
+      obj.current_total&.is_a?(Float) != false || raise("Passed value for field obj.current_total is not the expected type, validation failed.")
+      obj.change_this_period&.is_a?(Float) != false || raise("Passed value for field obj.change_this_period is not the expected type, validation failed.")
+      obj.percent_change&.is_a?(Float) != false || raise("Passed value for field obj.percent_change is not the expected type, validation failed.")
+      obj.percentile_this_period&.is_a?(Float) != false || raise("Passed value for field obj.percentile_this_period is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_most_active_day.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "completed_achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's most active day during the year.
+  class WrappedMostActiveDay
+    # @return [String] The date of the most active day in YYYY-MM-DD format.
+    attr_reader :date
+    # @return [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    attr_reader :metrics
+    # @return [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    attr_reader :points
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    attr_reader :achievements
+    # @return [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    attr_reader :leaderboards
+    # @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 most active day in YYYY-MM-DD format.
+    # @param metrics [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    # @param points [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    # @param leaderboards [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedMostActiveDay]
+    def initialize(date:, metrics:, points:, achievements:, leaderboards:, additional_properties: nil)
+      @date = date
+      @metrics = metrics
+      @points = points
+      @achievements = achievements
+      @leaderboards = leaderboards
+      @additional_properties = additional_properties
+      @_field_set = {
+        "date": date,
+        "metrics": metrics,
+        "points": points,
+        "achievements": achievements,
+        "leaderboards": leaderboards
+      }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedMostActiveDay
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedMostActiveDay]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      date = parsed_json["date"]
+      metrics = parsed_json["metrics"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedMetric.from_json(json_object: value)
+      end
+      points = parsed_json["points"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedPoints.from_json(json_object: value)
+      end
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
+      end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: value)
+      end
+      new(
+        date: date,
+        metrics: metrics,
+        points: points,
+        achievements: achievements,
+        leaderboards: leaderboards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedMostActiveDay 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.metrics.is_a?(Hash) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.leaderboards.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_most_active_month.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "completed_achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's most active month during the year.
+  class WrappedMostActiveMonth
+    # @return [Integer] The month number (0-11, where 0 is January).
+    attr_reader :month
+    # @return [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    attr_reader :metrics
+    # @return [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    attr_reader :points
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    attr_reader :achievements
+    # @return [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    attr_reader :leaderboards
+    # @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 month [Integer] The month number (0-11, where 0 is January).
+    # @param metrics [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    # @param points [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    # @param leaderboards [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedMostActiveMonth]
+    def initialize(month:, metrics:, points:, achievements:, leaderboards:, additional_properties: nil)
+      @month = month
+      @metrics = metrics
+      @points = points
+      @achievements = achievements
+      @leaderboards = leaderboards
+      @additional_properties = additional_properties
+      @_field_set = {
+        "month": month,
+        "metrics": metrics,
+        "points": points,
+        "achievements": achievements,
+        "leaderboards": leaderboards
+      }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedMostActiveMonth
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedMostActiveMonth]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      month = parsed_json["month"]
+      metrics = parsed_json["metrics"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedMetric.from_json(json_object: value)
+      end
+      points = parsed_json["points"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedPoints.from_json(json_object: value)
+      end
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
+      end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: value)
+      end
+      new(
+        month: month,
+        metrics: metrics,
+        points: points,
+        achievements: achievements,
+        leaderboards: leaderboards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedMostActiveMonth 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.month.is_a?(Integer) != false || raise("Passed value for field obj.month is not the expected type, validation failed.")
+      obj.metrics.is_a?(Hash) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.leaderboards.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
+    end
+  end
+end