trophy_api_client 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a079cc579c228bd0b3a7ceaba7f373d334d14b4cf63c50587b80436fa200ad8
-  data.tar.gz: 247f36d067c74363d21d68ae6e63b5a36c69862e6244f23e70691c6d9bfdabcf
+  metadata.gz: 74ccdc4a3dcbe88ed2254ca474165644225960617b4e4498f7deec3db6e209bc
+  data.tar.gz: 5f3cc5a4aa340463de78a5cdad7f043e56960cd5a9cdf50eb03c86934549d7e3
 SHA512:
-  metadata.gz: d45f9ee10bfce98ccc4917f47427e47d2c8467537e51ae9c884afdab11903764481d3693a26fd6033d66b30c0e0ca4e82a9d65ff816549c0ca054bba488557f9
-  data.tar.gz: 39c0511d4ee589e149261fd8db22978caa66412ee41849fb15eb2ecf1dc7fa823d832d7a8c02bba44307c02d7dc23a6832076e4e5f6fee6e0317ae20c928bfab
+  metadata.gz: d9176a0b52777a98068243e21bf0d891fe3035b3643cb54dc9514f359c4198186197492fef8b664e911b5dba3b8d81c2f66c11501a23270a653919fa3dd500bb
+  data.tar.gz: 9b870ec63aa0b1cf14cd716ed095f0b252672b415f6d11ff992cb948867059794f216c8b0dd5e28d3da2c4ae33e1e569d1e31a59dc124d36159e70e00db51259

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.1.1"
+    VERSION = "1.2.1"
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

data/lib/trophy_api_client/points/client.rb

@@ -5,6 +5,8 @@ require_relative "../types/points_summary_response"
 require "json"
 require_relative "../types/points_system_response"
 require_relative "../types/points_boost"
+require_relative "../types/points_level"
+require_relative "../types/points_level_summary_response"
 require "async"
 
 module TrophyApiClient
@@ -129,6 +131,79 @@ module TrophyApiClient
         TrophyApiClient::PointsBoost.from_json(json_object: item)
       end
     end
+
+    # Get all levels for a points system.
+    #
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsLevel>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.levels(key: "points-system-key")
+    def levels(key:, 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["X-API-KEY"] = request_options.api_key unless request_options&.api_key.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(environment: api, request_options: request_options)}/points/#{key}/levels"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsLevel.from_json(json_object: item)
+      end
+    end
+
+    # Get a breakdown of the number of users at each level in a points system.
+    #
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::POINTS_LEVEL_SUMMARY_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.level_summary(key: "points-system-key")
+    def level_summary(key:, 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["X-API-KEY"] = request_options.api_key unless request_options&.api_key.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(environment: api,
+                                           request_options: request_options)}/points/#{key}/level-summary"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsLevelSummaryResponseItem.from_json(json_object: item)
+      end
+    end
   end
 
   class AsyncPointsClient
@@ -258,5 +333,82 @@ module TrophyApiClient
         end
       end
     end
+
+    # Get all levels for a points system.
+    #
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsLevel>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.levels(key: "points-system-key")
+    def levels(key:, 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["X-API-KEY"] = request_options.api_key unless request_options&.api_key.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(environment: api, request_options: request_options)}/points/#{key}/levels"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::PointsLevel.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Get a breakdown of the number of users at each level in a points system.
+    #
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::POINTS_LEVEL_SUMMARY_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.points.level_summary(key: "points-system-key")
+    def level_summary(key:, 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["X-API-KEY"] = request_options.api_key unless request_options&.api_key.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(environment: api,
+                                             request_options: request_options)}/points/#{key}/level-summary"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::PointsLevelSummaryResponseItem.from_json(json_object: item)
+        end
+      end
+    end
   end
 end

data/lib/trophy_api_client/types/achievement_response.rb

@@ -24,6 +24,9 @@ module TrophyApiClient
     # @return [Integer] The length of the streak required to complete the achievement (only applicable
     #  if trigger = 'streak')
     attr_reader :streak_length
+    # @return [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
+    #  achievement (only applicable if trigger = 'achievement')
+    attr_reader :achievement_ids
     # @return [String] The ID of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     attr_reader :metric_id
@@ -56,6 +59,8 @@ module TrophyApiClient
     #  trigger = 'api')
     # @param streak_length [Integer] The length of the streak required to complete the achievement (only applicable
     #  if trigger = 'streak')
+    # @param achievement_ids [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
+    #  achievement (only applicable if trigger = 'achievement')
     # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
@@ -69,7 +74,7 @@ module TrophyApiClient
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementResponse]
     def initialize(id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OMIT, streak_length: OMIT,
-                   metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
+                   achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
       @id = id
       @name = name
       @trigger = trigger
@@ -77,6 +82,7 @@ module TrophyApiClient
       @badge_url = badge_url if badge_url != OMIT
       @key = key if key != OMIT
       @streak_length = streak_length if streak_length != OMIT
+      @achievement_ids = achievement_ids if achievement_ids != OMIT
       @metric_id = metric_id if metric_id != OMIT
       @metric_value = metric_value if metric_value != OMIT
       @metric_name = metric_name if metric_name != OMIT
@@ -91,6 +97,7 @@ module TrophyApiClient
         "badgeUrl": badge_url,
         "key": key,
         "streakLength": streak_length,
+        "achievementIds": achievement_ids,
         "metricId": metric_id,
         "metricValue": metric_value,
         "metricName": metric_name,
@@ -115,6 +122,7 @@ module TrophyApiClient
       badge_url = parsed_json["badgeUrl"]
       key = parsed_json["key"]
       streak_length = parsed_json["streakLength"]
+      achievement_ids = parsed_json["achievementIds"]
       metric_id = parsed_json["metricId"]
       metric_value = parsed_json["metricValue"]
       metric_name = parsed_json["metricName"]
@@ -136,6 +144,7 @@ module TrophyApiClient
         badge_url: badge_url,
         key: key,
         streak_length: streak_length,
+        achievement_ids: achievement_ids,
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
@@ -166,6 +175,7 @@ module TrophyApiClient
       obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url 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.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
+      obj.achievement_ids&.is_a?(Array) != false || raise("Passed value for field obj.achievement_ids is not the expected type, validation failed.")
       obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
       obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value 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.")

data/lib/trophy_api_client/types/achievement_response_trigger.rb

@@ -6,5 +6,6 @@ module TrophyApiClient
     METRIC = "metric"
     STREAK = "streak"
     API = "api"
+    ACHIEVEMENT = "achievement"
   end
 end

data/lib/trophy_api_client/types/achievement_with_stats_response.rb

@@ -28,6 +28,9 @@ module TrophyApiClient
     # @return [Integer] The length of the streak required to complete the achievement (only applicable
     #  if trigger = 'streak')
     attr_reader :streak_length
+    # @return [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
+    #  achievement (only applicable if trigger = 'achievement')
+    attr_reader :achievement_ids
     # @return [String] The ID of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     attr_reader :metric_id
@@ -62,6 +65,8 @@ module TrophyApiClient
     #  trigger = 'api')
     # @param streak_length [Integer] The length of the streak required to complete the achievement (only applicable
     #  if trigger = 'streak')
+    # @param achievement_ids [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
+    #  achievement (only applicable if trigger = 'achievement')
     # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
@@ -75,7 +80,7 @@ module TrophyApiClient
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementWithStatsResponse]
     def initialize(completions:, rarity:, id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OMIT,
-                   streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
+                   streak_length: OMIT, achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
       @completions = completions
       @rarity = rarity
       @id = id
@@ -85,6 +90,7 @@ module TrophyApiClient
       @badge_url = badge_url if badge_url != OMIT
       @key = key if key != OMIT
       @streak_length = streak_length if streak_length != OMIT
+      @achievement_ids = achievement_ids if achievement_ids != OMIT
       @metric_id = metric_id if metric_id != OMIT
       @metric_value = metric_value if metric_value != OMIT
       @metric_name = metric_name if metric_name != OMIT
@@ -101,6 +107,7 @@ module TrophyApiClient
         "badgeUrl": badge_url,
         "key": key,
         "streakLength": streak_length,
+        "achievementIds": achievement_ids,
         "metricId": metric_id,
         "metricValue": metric_value,
         "metricName": metric_name,
@@ -127,6 +134,7 @@ module TrophyApiClient
       badge_url = parsed_json["badgeUrl"]
       key = parsed_json["key"]
       streak_length = parsed_json["streakLength"]
+      achievement_ids = parsed_json["achievementIds"]
       metric_id = parsed_json["metricId"]
       metric_value = parsed_json["metricValue"]
       metric_name = parsed_json["metricName"]
@@ -150,6 +158,7 @@ module TrophyApiClient
         badge_url: badge_url,
         key: key,
         streak_length: streak_length,
+        achievement_ids: achievement_ids,
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
@@ -182,6 +191,7 @@ module TrophyApiClient
       obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url 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.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
+      obj.achievement_ids&.is_a?(Array) != false || raise("Passed value for field obj.achievement_ids is not the expected type, validation failed.")
       obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
       obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value 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.")

data/lib/trophy_api_client/types/get_user_points_response.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
+require_relative "points_level"
 require_relative "points_award"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   class GetUserPointsResponse
+    # @return [Integer] The user's total points
+    attr_reader :total
+    # @return [TrophyApiClient::PointsLevel] The user's current level in this points system, or null if no levels are
+    #  configured or the user hasn't reached any level yet.
+    attr_reader :level
+    # @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
@@ -18,10 +26,6 @@ module TrophyApiClient
     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 [Integer] The user's total points
-    attr_reader :total
-    # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
-    attr_reader :awards
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -30,36 +34,40 @@ module TrophyApiClient
 
     OMIT = Object.new
 
+    # @param total [Integer] The user's total points
+    # @param level [TrophyApiClient::PointsLevel] The user's current level in this points system, or null if no levels are
+    #  configured or the user hasn't reached any level yet.
+    # @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 total [Integer] The user's total points
-    # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::GetUserPointsResponse]
-    def initialize(id:, key:, name:, total:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
-                   additional_properties: nil)
+    def initialize(total:, awards:, id:, key:, name:, level: OMIT, description: OMIT, badge_url: OMIT,
+                   max_points: OMIT, additional_properties: nil)
+      @total = total
+      @level = level if level != OMIT
+      @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
-      @total = total
-      @awards = awards
       @additional_properties = additional_properties
       @_field_set = {
+        "total": total,
+        "level": level,
+        "awards": awards,
         "id": id,
         "key": key,
         "name": name,
         "description": description,
         "badgeUrl": badge_url,
-        "maxPoints": max_points,
-        "total": total,
-        "awards": awards
+        "maxPoints": max_points
       }.reject do |_k, v|
         v == OMIT
       end
@@ -72,26 +80,33 @@ module TrophyApiClient
     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
+      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"]
-      total = parsed_json["total"]
-      awards = parsed_json["awards"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::PointsAward.from_json(json_object: item)
-      end
       new(
+        total: total,
+        level: level,
+        awards: awards,
         id: id,
         key: key,
         name: name,
         description: description,
         badge_url: badge_url,
         max_points: max_points,
-        total: total,
-        awards: awards,
         additional_properties: struct
       )
     end
@@ -110,14 +125,15 @@ module TrophyApiClient
     # @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.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.")
-      obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total 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.")
     end
   end
 end

data/lib/trophy_api_client/types/metric_event_points_response.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
+require_relative "points_level"
 require_relative "points_award"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # Points system response for metric events.
+  # 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
@@ -19,12 +29,6 @@ module TrophyApiClient
     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 [Integer] The user's total points
-    attr_reader :total
-    # @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 [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -33,39 +37,43 @@ module TrophyApiClient
 
     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 total [Integer] The user's total points
-    # @param added [Integer] The points added by this event.
-    # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricEventPointsResponse]
-    def initialize(id:, key:, name:, total:, added:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
-                   additional_properties: nil)
+    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
-      @total = total
-      @added = added
-      @awards = awards
       @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,
-        "total": total,
-        "added": added,
-        "awards": awards
+        "maxPoints": max_points
       }.reject do |_k, v|
         v == OMIT
       end
@@ -78,28 +86,35 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      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"]
       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,
-        total: total,
-        added: added,
-        awards: awards,
         additional_properties: struct
       )
     end
@@ -118,15 +133,16 @@ module TrophyApiClient
     # @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.")
-      obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
-      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.")
     end
   end
 end