Automatically update Ruby SDK

Author: github-actions[bot]

lib/gemconfig.rb

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

lib/trophy_api_client/achievements/client.rb

@@ -20,6 +20,9 @@ def initialize(request_client:)
 
     # Get all achievements and their completion stats.
     #
+    # @param user_attributes [String] Optional colon-delimited user attributes in the format
+    #  attribute:value,attribute:value. Only achievements accessible to a user with the
+    #  provided attributes will be returned.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
     # @example
@@ -28,8 +31,8 @@ def initialize(request_client:)
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.all
-    def all(request_options: nil)
+    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
+    def all(user_attributes: nil, 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?
@@ -38,9 +41,10 @@ def all(request_options: nil)
       **@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
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "userAttributes": user_attributes
+        }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
         end
@@ -105,6 +109,9 @@ def initialize(request_client:)
 
     # Get all achievements and their completion stats.
     #
+    # @param user_attributes [String] Optional colon-delimited user attributes in the format
+    #  attribute:value,attribute:value. Only achievements accessible to a user with the
+    #  provided attributes will be returned.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
     # @example
@@ -113,8 +120,8 @@ def initialize(request_client:)
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.all
-    def all(request_options: nil)
+    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
+    def all(user_attributes: nil, 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?
@@ -124,9 +131,10 @@ def all(request_options: nil)
         **@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
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "userAttributes": user_attributes
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end

lib/trophy_api_client/leaderboards/client.rb

@@ -61,6 +61,9 @@ def all(request_options: nil)
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
+    #  parameter is required, and only valid for leaderboards with a breakdown
+    #  attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example
@@ -74,9 +77,10 @@ def all(request_options: nil)
     #    offset: 1,
     #    limit: 1,
     #    run: "2025-01-15",
-    #    user_id: "user-123"
+    #    user_id: "user-123",
+    #    user_attributes: "city:London"
     #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: nil, 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?
@@ -90,7 +94,8 @@ def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options:
           "offset": offset,
           "limit": limit,
           "run": run,
-          "userId": user_id
+          "userId": user_id,
+          "userAttributes": user_attributes
         }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -157,6 +162,9 @@ def all(request_options: nil)
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
+    #  parameter is required, and only valid for leaderboards with a breakdown
+    #  attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example
@@ -170,9 +178,10 @@ def all(request_options: nil)
     #    offset: 1,
     #    limit: 1,
     #    run: "2025-01-15",
-    #    user_id: "user-123"
+    #    user_id: "user-123",
+    #    user_attributes: "city:London"
     #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: nil, 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?
@@ -187,7 +196,8 @@ def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options:
             "offset": offset,
             "limit": limit,
             "run": run,
-            "userId": user_id
+            "userId": user_id,
+            "userAttributes": user_attributes
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact

lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb

@@ -19,6 +19,8 @@ class LeaderboardsAllResponseItem
       attr_reader :key
       # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
       attr_reader :rank_by
+      # @return [String] The key of the attribute to break down this leaderboard by.
+      attr_reader :breakdown_attribute
       # @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'.
@@ -55,6 +57,7 @@ class LeaderboardsAllResponseItem
       # @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] The key of the attribute to break down this leaderboard 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'.
@@ -70,13 +73,14 @@ class LeaderboardsAllResponseItem
       #  type.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
-      def initialize(status:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT,
-                     points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+      def initialize(status:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, breakdown_attribute: OMIT, metric_key: OMIT,
+                     metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
         @status = status
         @id = id
         @name = name
         @key = key
         @rank_by = rank_by
+        @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
         @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
@@ -94,6 +98,7 @@ def initialize(status:, id:, name:, key:, rank_by:, description:, start:, max_pa
           "name": name,
           "key": key,
           "rankBy": rank_by,
+          "breakdownAttribute": breakdown_attribute,
           "metricKey": metric_key,
           "metricName": metric_name,
           "pointsSystemKey": points_system_key,
@@ -121,6 +126,7 @@ def self.from_json(json_object:)
         name = parsed_json["name"]
         key = parsed_json["key"]
         rank_by = parsed_json["rankBy"]
+        breakdown_attribute = parsed_json["breakdownAttribute"]
         metric_key = parsed_json["metricKey"]
         metric_name = parsed_json["metricName"]
         points_system_key = parsed_json["pointsSystemKey"]
@@ -137,6 +143,7 @@ def self.from_json(json_object:)
           name: name,
           key: key,
           rank_by: rank_by,
+          breakdown_attribute: breakdown_attribute,
           metric_key: metric_key,
           metric_name: metric_name,
           points_system_key: points_system_key,
@@ -170,6 +177,7 @@ def self.validate_raw(obj:)
         obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.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.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.")

lib/trophy_api_client/points/client.rb

@@ -21,8 +21,8 @@ def initialize(request_client:)
     #
     # @param key [String] Key of the points system.
     # @param user_attributes [String] Optional colon-delimited user attribute filters in the format
-    #  attributeKey:value,attributeKey:value. Only users matching ALL specified
-    #  attributes will be included in the points breakdown.
+    #  attribute:value,attribute:value. Only users matching ALL specified attributes
+    #  will be included in the points breakdown.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
     # @example
@@ -104,8 +104,8 @@ def initialize(request_client:)
     #
     # @param key [String] Key of the points system.
     # @param user_attributes [String] Optional colon-delimited user attribute filters in the format
-    #  attributeKey:value,attributeKey:value. Only users matching ALL specified
-    #  attributes will be included in the points breakdown.
+    #  attribute:value,attribute:value. Only users matching ALL specified attributes
+    #  will be included in the points breakdown.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
     # @example

lib/trophy_api_client/types/leaderboard_response.rb

@@ -16,6 +16,8 @@ class LeaderboardResponse
     attr_reader :key
     # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
     attr_reader :rank_by
+    # @return [String] The key of the attribute to break down this leaderboard by.
+    attr_reader :breakdown_attribute
     # @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'.
@@ -51,6 +53,7 @@ class LeaderboardResponse
     # @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] The key of the attribute to break down this leaderboard 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'.
@@ -66,12 +69,13 @@ class LeaderboardResponse
     #  type.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::LeaderboardResponse]
-    def initialize(id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT,
-                   points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+    def initialize(id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT,
+                   points_system_key: OMIT, points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
       @id = id
       @name = name
       @key = key
       @rank_by = rank_by
+      @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
       @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
@@ -88,6 +92,7 @@ def initialize(id:, name:, key:, rank_by:, description:, start:, max_participant
         "name": name,
         "key": key,
         "rankBy": rank_by,
+        "breakdownAttribute": breakdown_attribute,
         "metricKey": metric_key,
         "metricName": metric_name,
         "pointsSystemKey": points_system_key,
@@ -114,6 +119,7 @@ def self.from_json(json_object:)
       name = parsed_json["name"]
       key = parsed_json["key"]
       rank_by = parsed_json["rankBy"]
+      breakdown_attribute = parsed_json["breakdownAttribute"]
       metric_key = parsed_json["metricKey"]
       metric_name = parsed_json["metricName"]
       points_system_key = parsed_json["pointsSystemKey"]
@@ -129,6 +135,7 @@ def self.from_json(json_object:)
         name: name,
         key: key,
         rank_by: rank_by,
+        breakdown_attribute: breakdown_attribute,
         metric_key: metric_key,
         metric_name: metric_name,
         points_system_key: points_system_key,
@@ -161,6 +168,7 @@ def self.validate_raw(obj:)
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.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.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.")