trophy_api_client 1.14.0 → 1.26.1

data/lib/trophy_api_client/types/list_points_levels_response.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_points_level"
-
-module TrophyApiClient
-  LIST_POINTS_LEVELS_RESPONSE = Array
-end

data/lib/trophy_api_client/types/list_points_systems_response.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_points_system"
-
-module TrophyApiClient
-  LIST_POINTS_SYSTEMS_RESPONSE = Array
-end

data/lib/trophy_api_client/types/list_points_triggers_response.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_points_trigger"
-
-module TrophyApiClient
-  LIST_POINTS_TRIGGERS_RESPONSE = Array
-end

data/lib/trophy_api_client/types/list_tenants_response.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_tenant"
-
-module TrophyApiClient
-  LIST_TENANTS_RESPONSE = Array
-end

data/lib/trophy_api_client/types/metric_event_leaderboard_response.rb

@@ -1,245 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "metric_event_leaderboard_response_breakdown_attribute_values_item"
-require_relative "leaderboard_response_rank_by"
-require_relative "leaderboard_response_run_unit"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class MetricEventLeaderboardResponse
-    # @return [String] The end date of the current run of the leaderboard, or null if the run never
-    #  ends.
-    attr_reader :end_
-    # @return [Integer] The user's rank in the leaderboard, or null if the user is not on the
-    #  leaderboard.
-    attr_reader :rank
-    # @return [Integer] The user's rank in the leaderboard before the event, or null if the user was not
-    #  on the leaderboard before the event.
-    attr_reader :previous_rank
-    # @return [Integer] The minimum value required to enter the leaderboard according to its current
-    #  rankings.
-    attr_reader :threshold
-    # @return [String] Deprecated. For leaderboards with a single breakdown attribute, the value of
-    #  that attribute for the user.
-    attr_reader :breakdown_attribute_value
-    # @return [Array<TrophyApiClient::MetricEventLeaderboardResponseBreakdownAttributeValuesItem>] For leaderboards with breakdown attributes, the user's values for each breakdown
-    #  attribute.
-    attr_reader :breakdown_attribute_values
-    # @return [String] The unique ID of the leaderboard.
-    attr_reader :id
-    # @return [String] The user-facing name of the leaderboard.
-    attr_reader :name
-    # @return [String] The unique key used to reference the leaderboard in APIs.
-    attr_reader :key
-    # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
-    attr_reader :rank_by
-    # @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
-    attr_reader :breakdown_attribute
-    # @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
-    attr_reader :breakdown_attributes
-    # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
-    attr_reader :metric_key
-    # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
-    attr_reader :metric_name
-    # @return [String] The key of the points system to rank by, if rankBy is 'points'.
-    attr_reader :points_system_key
-    # @return [String] The name of the points system to rank by, if rankBy is 'points'.
-    attr_reader :points_system_name
-    # @return [String] The user-facing description of the leaderboard.
-    attr_reader :description
-    # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
-    attr_reader :start
-    # @return [Integer] The maximum number of participants in the leaderboard.
-    attr_reader :max_participants
-    # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
-    #  leaderboards.
-    attr_reader :run_unit
-    # @return [Integer] The interval between repetitions, relative to the start date and repetition
-    #  type. Null for one-time leaderboards.
-    attr_reader :run_interval
-    # @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 end_ [String] The end date of the current run of the leaderboard, or null if the run never
-    #  ends.
-    # @param rank [Integer] The user's rank in the leaderboard, or null if the user is not on the
-    #  leaderboard.
-    # @param previous_rank [Integer] The user's rank in the leaderboard before the event, or null if the user was not
-    #  on the leaderboard before the event.
-    # @param threshold [Integer] The minimum value required to enter the leaderboard according to its current
-    #  rankings.
-    # @param breakdown_attribute_value [String] Deprecated. For leaderboards with a single breakdown attribute, the value of
-    #  that attribute for the user.
-    # @param breakdown_attribute_values [Array<TrophyApiClient::MetricEventLeaderboardResponseBreakdownAttributeValuesItem>] For leaderboards with breakdown attributes, the user's values for each breakdown
-    #  attribute.
-    # @param id [String] The unique ID of the leaderboard.
-    # @param name [String] The user-facing name of the leaderboard.
-    # @param key [String] The unique key used to reference the leaderboard in APIs.
-    # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
-    # @param breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
-    # @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
-    # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
-    # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
-    # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
-    # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
-    # @param description [String] The user-facing description of the leaderboard.
-    # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
-    # @param max_participants [Integer] The maximum number of participants in the leaderboard.
-    # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
-    #  leaderboards.
-    # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
-    #  type. Null for one-time leaderboards.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::MetricEventLeaderboardResponse]
-    def initialize(threshold:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, end_: OMIT, rank: OMIT, previous_rank: OMIT, breakdown_attribute_value: OMIT,
-                   breakdown_attribute_values: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
-      @end_ = end_ if end_ != OMIT
-      @rank = rank if rank != OMIT
-      @previous_rank = previous_rank if previous_rank != OMIT
-      @threshold = threshold
-      @breakdown_attribute_value = breakdown_attribute_value if breakdown_attribute_value != OMIT
-      @breakdown_attribute_values = breakdown_attribute_values if breakdown_attribute_values != OMIT
-      @id = id
-      @name = name
-      @key = key
-      @rank_by = rank_by
-      @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
-      @breakdown_attributes = breakdown_attributes
-      @metric_key = metric_key if metric_key != OMIT
-      @metric_name = metric_name if metric_name != OMIT
-      @points_system_key = points_system_key if points_system_key != OMIT
-      @points_system_name = points_system_name if points_system_name != OMIT
-      @description = description if description != OMIT
-      @start = start
-      @max_participants = max_participants if max_participants != OMIT
-      @run_unit = run_unit if run_unit != OMIT
-      @run_interval = run_interval if run_interval != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "end": end_,
-        "rank": rank,
-        "previousRank": previous_rank,
-        "threshold": threshold,
-        "breakdownAttributeValue": breakdown_attribute_value,
-        "breakdownAttributeValues": breakdown_attribute_values,
-        "id": id,
-        "name": name,
-        "key": key,
-        "rankBy": rank_by,
-        "breakdownAttribute": breakdown_attribute,
-        "breakdownAttributes": breakdown_attributes,
-        "metricKey": metric_key,
-        "metricName": metric_name,
-        "pointsSystemKey": points_system_key,
-        "pointsSystemName": points_system_name,
-        "description": description,
-        "start": start,
-        "maxParticipants": max_participants,
-        "runUnit": run_unit,
-        "runInterval": run_interval
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of MetricEventLeaderboardResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::MetricEventLeaderboardResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      end_ = parsed_json["end"]
-      rank = parsed_json["rank"]
-      previous_rank = parsed_json["previousRank"]
-      threshold = parsed_json["threshold"]
-      breakdown_attribute_value = parsed_json["breakdownAttributeValue"]
-      breakdown_attribute_values = parsed_json["breakdownAttributeValues"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::MetricEventLeaderboardResponseBreakdownAttributeValuesItem.from_json(json_object: item)
-      end
-      id = parsed_json["id"]
-      name = parsed_json["name"]
-      key = parsed_json["key"]
-      rank_by = parsed_json["rankBy"]
-      breakdown_attribute = parsed_json["breakdownAttribute"]
-      breakdown_attributes = parsed_json["breakdownAttributes"]
-      metric_key = parsed_json["metricKey"]
-      metric_name = parsed_json["metricName"]
-      points_system_key = parsed_json["pointsSystemKey"]
-      points_system_name = parsed_json["pointsSystemName"]
-      description = parsed_json["description"]
-      start = parsed_json["start"]
-      max_participants = parsed_json["maxParticipants"]
-      run_unit = parsed_json["runUnit"]
-      run_interval = parsed_json["runInterval"]
-      new(
-        end_: end_,
-        rank: rank,
-        previous_rank: previous_rank,
-        threshold: threshold,
-        breakdown_attribute_value: breakdown_attribute_value,
-        breakdown_attribute_values: breakdown_attribute_values,
-        id: id,
-        name: name,
-        key: key,
-        rank_by: rank_by,
-        breakdown_attribute: breakdown_attribute,
-        breakdown_attributes: breakdown_attributes,
-        metric_key: metric_key,
-        metric_name: metric_name,
-        points_system_key: points_system_key,
-        points_system_name: points_system_name,
-        description: description,
-        start: start,
-        max_participants: max_participants,
-        run_unit: run_unit,
-        run_interval: run_interval,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of MetricEventLeaderboardResponse 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.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-      obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
-      obj.previous_rank&.is_a?(Integer) != false || raise("Passed value for field obj.previous_rank is not the expected type, validation failed.")
-      obj.threshold.is_a?(Integer) != false || raise("Passed value for field obj.threshold is not the expected type, validation failed.")
-      obj.breakdown_attribute_value&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute_value is not the expected type, validation failed.")
-      obj.breakdown_attribute_values&.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attribute_values is not the expected type, validation failed.")
-      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
-      obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
-      obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
-      obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
-      obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
-      obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
-      obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name is not the expected type, validation failed.")
-      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-      obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
-      obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
-      obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
-      obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class MetricEventLeaderboardResponseBreakdownAttributeValuesItem
-    # @return [String] The key of the breakdown attribute.
-    attr_reader :key
-    # @return [String] The user's value for the breakdown attribute.
-    attr_reader :value
-    # @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 key [String] The key of the breakdown attribute.
-    # @param value [String] The user's value for the breakdown attribute.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::MetricEventLeaderboardResponseBreakdownAttributeValuesItem]
-    def initialize(key:, value:, additional_properties: nil)
-      @key = key
-      @value = value
-      @additional_properties = additional_properties
-      @_field_set = { "key": key, "value": value }
-    end
-
-    # Deserialize a JSON object to an instance of
-    #  MetricEventLeaderboardResponseBreakdownAttributeValuesItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::MetricEventLeaderboardResponseBreakdownAttributeValuesItem]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      key = parsed_json["key"]
-      value = parsed_json["value"]
-      new(
-        key: key,
-        value: value,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of
-    #  MetricEventLeaderboardResponseBreakdownAttributeValuesItem 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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/metric_event_points_response.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "points_level"
-require_relative "points_award"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # Points system response for metric events and achievement completions.
-  class MetricEventPointsResponse
-    # @return [Integer] The user's total points
-    attr_reader :total
-    # @return [TrophyApiClient::PointsLevel] The user's new level, included only when the level changed as a result of this
-    #  event.
-    attr_reader :level
-    # @return [Integer] The points added by this event.
-    attr_reader :added
-    # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
-    attr_reader :awards
-    # @return [String] The ID of the points system
-    attr_reader :id
-    # @return [String] The key of the points system
-    attr_reader :key
-    # @return [String] The name of the points system
-    attr_reader :name
-    # @return [String] The description of the points system
-    attr_reader :description
-    # @return [String] The URL of the badge image for the points system
-    attr_reader :badge_url
-    # @return [Float] The maximum number of points a user can be awarded in this points system
-    attr_reader :max_points
-    # @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 total [Integer] The user's total points
-    # @param level [TrophyApiClient::PointsLevel] The user's new level, included only when the level changed as a result of this
-    #  event.
-    # @param added [Integer] The points added by this event.
-    # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
-    # @param id [String] The ID of the points system
-    # @param key [String] The key of the points system
-    # @param name [String] The name of the points system
-    # @param description [String] The description of the points system
-    # @param badge_url [String] The URL of the badge image for the points system
-    # @param max_points [Float] The maximum number of points a user can be awarded in this points system
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::MetricEventPointsResponse]
-    def initialize(total:, added:, awards:, id:, key:, name:, level: OMIT, description: OMIT, badge_url: OMIT,
-                   max_points: OMIT, additional_properties: nil)
-      @total = total
-      @level = level if level != OMIT
-      @added = added
-      @awards = awards
-      @id = id
-      @key = key
-      @name = name
-      @description = description if description != OMIT
-      @badge_url = badge_url if badge_url != OMIT
-      @max_points = max_points if max_points != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "total": total,
-        "level": level,
-        "added": added,
-        "awards": awards,
-        "id": id,
-        "key": key,
-        "name": name,
-        "description": description,
-        "badgeUrl": badge_url,
-        "maxPoints": max_points
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of MetricEventPointsResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::MetricEventPointsResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      total = parsed_json["total"]
-      if parsed_json["level"].nil?
-        level = nil
-      else
-        level = parsed_json["level"].to_json
-        level = TrophyApiClient::PointsLevel.from_json(json_object: level)
-      end
-      added = parsed_json["added"]
-      awards = parsed_json["awards"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::PointsAward.from_json(json_object: item)
-      end
-      id = parsed_json["id"]
-      key = parsed_json["key"]
-      name = parsed_json["name"]
-      description = parsed_json["description"]
-      badge_url = parsed_json["badgeUrl"]
-      max_points = parsed_json["maxPoints"]
-      new(
-        total: total,
-        level: level,
-        added: added,
-        awards: awards,
-        id: id,
-        key: key,
-        name: name,
-        description: description,
-        badge_url: badge_url,
-        max_points: max_points,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of MetricEventPointsResponse 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.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
-      obj.level.nil? || TrophyApiClient::PointsLevel.validate_raw(obj: obj.level)
-      obj.added.is_a?(Integer) != false || raise("Passed value for field obj.added is not the expected type, validation failed.")
-      obj.awards.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
-      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-      obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
-      obj.max_points&.is_a?(Float) != false || raise("Passed value for field obj.max_points is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/metric_event_streak_response.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "streak_frequency"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An object representing the user's streak after sending a metric event.
-  class MetricEventStreakResponse
-    # @return [Boolean] Whether this metric event increased the user's streak length.
-    attr_reader :extended
-    # @return [Integer] The length of the user's current streak.
-    attr_reader :length
-    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    attr_reader :frequency
-    # @return [String] The date the streak started.
-    attr_reader :started
-    # @return [String] The start date of the current streak period.
-    attr_reader :period_start
-    # @return [String] The end date of the current streak period.
-    attr_reader :period_end
-    # @return [String] The date the streak will expire if the user does not increment a metric.
-    attr_reader :expires
-    # @return [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    attr_reader :freezes
-    # @return [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    attr_reader :max_freezes
-    # @return [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_interval
-    # @return [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_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 extended [Boolean] Whether this metric event increased the user's streak length.
-    # @param length [Integer] The length of the user's current streak.
-    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    # @param started [String] The date the streak started.
-    # @param period_start [String] The start date of the current streak period.
-    # @param period_end [String] The end date of the current streak period.
-    # @param expires [String] The date the streak will expire if the user does not increment a metric.
-    # @param freezes [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    # @param max_freezes [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    # @param freeze_auto_earn_interval [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    # @param freeze_auto_earn_amount [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::MetricEventStreakResponse]
-    def initialize(extended:, length:, frequency:, started: OMIT, period_start: OMIT, period_end: OMIT, expires: OMIT,
-                   freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
-      @extended = extended
-      @length = length
-      @frequency = frequency
-      @started = started if started != OMIT
-      @period_start = period_start if period_start != OMIT
-      @period_end = period_end if period_end != OMIT
-      @expires = expires if expires != OMIT
-      @freezes = freezes if freezes != OMIT
-      @max_freezes = max_freezes if max_freezes != OMIT
-      @freeze_auto_earn_interval = freeze_auto_earn_interval if freeze_auto_earn_interval != OMIT
-      @freeze_auto_earn_amount = freeze_auto_earn_amount if freeze_auto_earn_amount != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "extended": extended,
-        "length": length,
-        "frequency": frequency,
-        "started": started,
-        "periodStart": period_start,
-        "periodEnd": period_end,
-        "expires": expires,
-        "freezes": freezes,
-        "maxFreezes": max_freezes,
-        "freezeAutoEarnInterval": freeze_auto_earn_interval,
-        "freezeAutoEarnAmount": freeze_auto_earn_amount
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of MetricEventStreakResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::MetricEventStreakResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      extended = parsed_json["extended"]
-      length = parsed_json["length"]
-      frequency = parsed_json["frequency"]
-      started = parsed_json["started"]
-      period_start = parsed_json["periodStart"]
-      period_end = parsed_json["periodEnd"]
-      expires = parsed_json["expires"]
-      freezes = parsed_json["freezes"]
-      max_freezes = parsed_json["maxFreezes"]
-      freeze_auto_earn_interval = parsed_json["freezeAutoEarnInterval"]
-      freeze_auto_earn_amount = parsed_json["freezeAutoEarnAmount"]
-      new(
-        extended: extended,
-        length: length,
-        frequency: frequency,
-        started: started,
-        period_start: period_start,
-        period_end: period_end,
-        expires: expires,
-        freezes: freezes,
-        max_freezes: max_freezes,
-        freeze_auto_earn_interval: freeze_auto_earn_interval,
-        freeze_auto_earn_amount: freeze_auto_earn_amount,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of MetricEventStreakResponse 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.extended.is_a?(Boolean) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
-      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
-      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
-      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
-      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
-      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
-      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
-      obj.freezes&.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
-      obj.max_freezes&.is_a?(Integer) != false || raise("Passed value for field obj.max_freezes is not the expected type, validation failed.")
-      obj.freeze_auto_earn_interval&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_interval is not the expected type, validation failed.")
-      obj.freeze_auto_earn_amount&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_amount is not the expected type, validation failed.")
-    end
-  end
-end