trophy_api_client 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97da192c802d186875e81388f3968949a9b0f024a8478ee8d5baf28e1c219175
-  data.tar.gz: d1edd13e0be799fff70fc6e57d8d1bee94c293263e7f010ef413c48a019c4318
+  metadata.gz: 74ccdc4a3dcbe88ed2254ca474165644225960617b4e4498f7deec3db6e209bc
+  data.tar.gz: 5f3cc5a4aa340463de78a5cdad7f043e56960cd5a9cdf50eb03c86934549d7e3
 SHA512:
-  metadata.gz: 443da8a6cc5b0c65e11fcbe5966fe2e2db448626153288d46348c00369c4eac5d1a04a136bcc15a121da46e2fec33e2f37f614601b9faa7448b51d39c2e7fdf1
-  data.tar.gz: cc7f1ed682b50720fc52356c3985aa24f7b68da236bdd1fc2a5e0b8ba3087ed19f4f0db232366c6886a5cd6b061d1dc73973a12885a523f545743c97515242cb
+  metadata.gz: d9176a0b52777a98068243e21bf0d891fe3035b3643cb54dc9514f359c4198186197492fef8b664e911b5dba3b8d81c2f66c11501a23270a653919fa3dd500bb
+  data.tar.gz: 9b870ec63aa0b1cf14cd716ed095f0b252672b415f6d11ff992cb948867059794f216c8b0dd5e28d3da2c4ae33e1e569d1e31a59dc124d36159e70e00db51259

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.1.2"
+    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/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

data/lib/trophy_api_client/types/points_level.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A level within a points system.
+  class PointsLevel
+    # @return [String] The ID of the level
+    attr_reader :id
+    # @return [String] The unique key of the level
+    attr_reader :key
+    # @return [String] The name of the level
+    attr_reader :name
+    # @return [String] The description of the level
+    attr_reader :description
+    # @return [String] The URL of the badge image for the level
+    attr_reader :badge_url
+    # @return [Integer] The points threshold required to reach this level
+    attr_reader :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 id [String] The ID of the level
+    # @param key [String] The unique key of the level
+    # @param name [String] The name of the level
+    # @param description [String] The description of the level
+    # @param badge_url [String] The URL of the badge image for the level
+    # @param points [Integer] The points threshold required to reach this level
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsLevel]
+    def initialize(id:, key:, name:, description:, points:, badge_url: OMIT, additional_properties: nil)
+      @id = id
+      @key = key
+      @name = name
+      @description = description
+      @badge_url = badge_url if badge_url != OMIT
+      @points = points
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "key": key,
+        "name": name,
+        "description": description,
+        "badgeUrl": badge_url,
+        "points": points
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsLevel
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsLevel]
+    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"]
+      points = parsed_json["points"]
+      new(
+        id: id,
+        key: key,
+        name: name,
+        description: description,
+        badge_url: badge_url,
+        points: points,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsLevel 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.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.points.is_a?(Integer) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_level_summary_response.rb

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

data/lib/trophy_api_client/types/points_level_summary_response_item.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "points_level"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsLevelSummaryResponseItem
+    # @return [TrophyApiClient::PointsLevel]
+    attr_reader :level
+    # @return [Integer] The number of users currently at this level
+    attr_reader :users
+    # @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 level [TrophyApiClient::PointsLevel]
+    # @param users [Integer] The number of users currently at this level
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsLevelSummaryResponseItem]
+    def initialize(level:, users:, additional_properties: nil)
+      @level = level
+      @users = users
+      @additional_properties = additional_properties
+      @_field_set = { "level": level, "users": users }
+    end
+
+    # Deserialize a JSON object to an instance of PointsLevelSummaryResponseItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsLevelSummaryResponseItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["level"].nil?
+        level = nil
+      else
+        level = parsed_json["level"].to_json
+        level = TrophyApiClient::PointsLevel.from_json(json_object: level)
+      end
+      users = parsed_json["users"]
+      new(
+        level: level,
+        users: users,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsLevelSummaryResponseItem 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::PointsLevel.validate_raw(obj: obj.level)
+      obj.users.is_a?(Integer) != false || raise("Passed value for field obj.users is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Base points system fields shared across responses.
+  class PointsResponse
+    # @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 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::PointsResponse]
+    def initialize(id:, key:, name:, description: OMIT, badge_url: OMIT, max_points: OMIT, additional_properties: nil)
+      @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 = {
+        "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 PointsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsResponse]
+    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"]
+      new(
+        id: id,
+        key: key,
+        name: name,
+        description: description,
+        badge_url: badge_url,
+        max_points: max_points,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsResponse 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.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/webhooks_points_level_changed_payload.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "webhooks_points_level_changed_payload_points"
+require_relative "points_level"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksPointsLevelChangedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user whose level changed.
+    attr_reader :user
+    # @return [TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints] The points system in which the level changed.
+    attr_reader :points
+    # @return [TrophyApiClient::PointsLevel] The user's previous level, or null if the user had no level.
+    attr_reader :previous_level
+    # @return [TrophyApiClient::PointsLevel] The user's new level, or null if the user no longer has a level.
+    attr_reader :new_level
+    # @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 type [String] The webhook event type.
+    # @param user [TrophyApiClient::User] The user whose level changed.
+    # @param points [TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints] The points system in which the level changed.
+    # @param previous_level [TrophyApiClient::PointsLevel] The user's previous level, or null if the user had no level.
+    # @param new_level [TrophyApiClient::PointsLevel] The user's new level, or null if the user no longer has a level.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksPointsLevelChangedPayload]
+    def initialize(type:, user:, points:, previous_level: OMIT, new_level: OMIT, additional_properties: nil)
+      @type = type
+      @user = user
+      @points = points
+      @previous_level = previous_level if previous_level != OMIT
+      @new_level = new_level if new_level != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "type": type,
+        "user": user,
+        "points": points,
+        "previousLevel": previous_level,
+        "newLevel": new_level
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksPointsLevelChangedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksPointsLevelChangedPayload]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      if parsed_json["user"].nil?
+        user = nil
+      else
+        user = parsed_json["user"].to_json
+        user = TrophyApiClient::User.from_json(json_object: user)
+      end
+      if parsed_json["points"].nil?
+        points = nil
+      else
+        points = parsed_json["points"].to_json
+        points = TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints.from_json(json_object: points)
+      end
+      if parsed_json["previousLevel"].nil?
+        previous_level = nil
+      else
+        previous_level = parsed_json["previousLevel"].to_json
+        previous_level = TrophyApiClient::PointsLevel.from_json(json_object: previous_level)
+      end
+      if parsed_json["newLevel"].nil?
+        new_level = nil
+      else
+        new_level = parsed_json["newLevel"].to_json
+        new_level = TrophyApiClient::PointsLevel.from_json(json_object: new_level)
+      end
+      new(
+        type: type,
+        user: user,
+        points: points,
+        previous_level: previous_level,
+        new_level: new_level,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksPointsLevelChangedPayload 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      TrophyApiClient::User.validate_raw(obj: obj.user)
+      TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints.validate_raw(obj: obj.points)
+      obj.previous_level.nil? || TrophyApiClient::PointsLevel.validate_raw(obj: obj.previous_level)
+      obj.new_level.nil? || TrophyApiClient::PointsLevel.validate_raw(obj: obj.new_level)
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_points_level_changed_payload_points.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The points system in which the level changed.
+  class WebhooksPointsLevelChangedPayloadPoints
+    # @return [Integer] The user's total points in this system.
+    attr_reader :total
+    # @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 in this system.
+    # @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::WebhooksPointsLevelChangedPayloadPoints]
+    def initialize(total:, id:, key:, name:, description: OMIT, badge_url: OMIT, max_points: OMIT,
+                   additional_properties: nil)
+      @total = total
+      @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,
+        "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
+    #  WebhooksPointsLevelChangedPayloadPoints
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      total = parsed_json["total"]
+      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,
+        id: id,
+        key: key,
+        name: name,
+        description: description,
+        badge_url: badge_url,
+        max_points: max_points,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksPointsLevelChangedPayloadPoints 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.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/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.1.2"
+  VERSION = "1.2.1"
 end

data/lib/types_export.rb

@@ -18,6 +18,8 @@ require_relative "trophy_api_client/types/webhooks_streak_lost_payload"
 require_relative "trophy_api_client/types/webhooks_streak_freeze_consumed_payload"
 require_relative "trophy_api_client/types/webhooks_streak_freeze_earned_payload"
 require_relative "trophy_api_client/types/webhooks_points_changed_payload"
+require_relative "trophy_api_client/types/webhooks_points_level_changed_payload_points"
+require_relative "trophy_api_client/types/webhooks_points_level_changed_payload"
 require_relative "trophy_api_client/types/webhooks_points_boost_started_payload"
 require_relative "trophy_api_client/types/webhooks_points_boost_finished_payload"
 require_relative "trophy_api_client/types/webhooks_leaderboard_started_payload"
@@ -42,7 +44,11 @@ require_relative "trophy_api_client/types/points_boost"
 require_relative "trophy_api_client/types/points_boost_webhook_payload_status"
 require_relative "trophy_api_client/types/points_boost_webhook_payload_rounding"
 require_relative "trophy_api_client/types/points_boost_webhook_payload"
+require_relative "trophy_api_client/types/points_response"
 require_relative "trophy_api_client/types/get_user_points_response"
+require_relative "trophy_api_client/types/points_level_summary_response_item"
+require_relative "trophy_api_client/types/points_level_summary_response"
+require_relative "trophy_api_client/types/points_level"
 require_relative "trophy_api_client/types/leaderboard_response_rank_by"
 require_relative "trophy_api_client/types/leaderboard_response_run_unit"
 require_relative "trophy_api_client/types/leaderboard_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -158,7 +158,11 @@ files:
 - lib/trophy_api_client/types/points_boost_webhook_payload.rb
 - lib/trophy_api_client/types/points_boost_webhook_payload_rounding.rb
 - lib/trophy_api_client/types/points_boost_webhook_payload_status.rb
+- lib/trophy_api_client/types/points_level.rb
+- lib/trophy_api_client/types/points_level_summary_response.rb
+- lib/trophy_api_client/types/points_level_summary_response_item.rb
 - lib/trophy_api_client/types/points_range.rb
+- lib/trophy_api_client/types/points_response.rb
 - lib/trophy_api_client/types/points_summary_response.rb
 - lib/trophy_api_client/types/points_system_response.rb
 - lib/trophy_api_client/types/points_trigger.rb
@@ -192,6 +196,8 @@ files:
 - lib/trophy_api_client/types/webhooks_points_boost_finished_payload.rb
 - lib/trophy_api_client/types/webhooks_points_boost_started_payload.rb
 - lib/trophy_api_client/types/webhooks_points_changed_payload.rb
+- lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb
+- lib/trophy_api_client/types/webhooks_points_level_changed_payload_points.rb
 - lib/trophy_api_client/types/webhooks_streak_extended_payload.rb
 - lib/trophy_api_client/types/webhooks_streak_freeze_consumed_payload.rb
 - lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb
@@ -235,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby library for the Trophy API.
 test_files: []