Automatically update Ruby SDK

Author: github-actions[bot]

lib/gemconfig.rb

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

lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb

@@ -19,8 +19,10 @@ 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.
+      # @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
       attr_reader :breakdown_attribute
+      # @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
+      attr_reader :breakdown_attributes
       # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
       attr_reader :metric_key
       # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
@@ -57,7 +59,8 @@ 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 breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
+      # @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
       # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
       # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
       # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
@@ -73,14 +76,15 @@ class LeaderboardsAllResponseItem
       #  type. Null for one-time leaderboards.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
-      def initialize(status:, id:, name:, key:, rank_by:, start:, max_participants:, breakdown_attribute: OMIT, metric_key: OMIT,
-                     metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+      def initialize(status:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, max_participants:, breakdown_attribute: OMIT,
+                     metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
         @status = status
         @id = id
         @name = name
         @key = key
         @rank_by = rank_by
         @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
+        @breakdown_attributes = breakdown_attributes
         @metric_key = metric_key if metric_key != OMIT
         @metric_name = metric_name if metric_name != OMIT
         @points_system_key = points_system_key if points_system_key != OMIT
@@ -99,6 +103,7 @@ def initialize(status:, id:, name:, key:, rank_by:, start:, max_participants:, b
           "key": key,
           "rankBy": rank_by,
           "breakdownAttribute": breakdown_attribute,
+          "breakdownAttributes": breakdown_attributes,
           "metricKey": metric_key,
           "metricName": metric_name,
           "pointsSystemKey": points_system_key,
@@ -127,6 +132,7 @@ def self.from_json(json_object:)
         key = parsed_json["key"]
         rank_by = parsed_json["rankBy"]
         breakdown_attribute = parsed_json["breakdownAttribute"]
+        breakdown_attributes = parsed_json["breakdownAttributes"]
         metric_key = parsed_json["metricKey"]
         metric_name = parsed_json["metricName"]
         points_system_key = parsed_json["pointsSystemKey"]
@@ -144,6 +150,7 @@ def self.from_json(json_object:)
           key: key,
           rank_by: rank_by,
           breakdown_attribute: breakdown_attribute,
+          breakdown_attributes: breakdown_attributes,
           metric_key: metric_key,
           metric_name: metric_name,
           points_system_key: points_system_key,
@@ -178,6 +185,7 @@ def self.validate_raw(obj:)
         obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
         obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
         obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
+        obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
         obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
         obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
         obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")

lib/trophy_api_client/types/achievement_response.rb

@@ -3,6 +3,7 @@
 require_relative "achievement_response_trigger"
 require_relative "achievement_response_user_attributes_item"
 require_relative "achievement_response_event_attribute"
+require_relative "achievement_response_event_attributes_item"
 require "ostruct"
 require "json"
 
@@ -37,11 +38,13 @@ class AchievementResponse
     #  trigger = 'metric')
     attr_reader :metric_name
     # @return [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
-    #  Only present if the achievement has user attribute filters configured.
     attr_reader :user_attributes
-    # @return [TrophyApiClient::AchievementResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
-    #  Only present if the achievement has an event filter configured.
+    # @return [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
+    #  completed. Only present if the achievement has an event filter configured.
     attr_reader :event_attribute
+    # @return [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
+    #  Omitted for non-metric achievements.
+    attr_reader :event_attributes
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -68,13 +71,14 @@ class AchievementResponse
     # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
     #  trigger = 'metric')
     # @param user_attributes [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
-    #  Only present if the achievement has user attribute filters configured.
-    # @param event_attribute [TrophyApiClient::AchievementResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
-    #  Only present if the achievement has an event filter configured.
+    # @param event_attribute [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
+    #  completed. Only present if the achievement has an event filter configured.
+    # @param event_attributes [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
+    #  Omitted for non-metric achievements.
     # @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,
-                   achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, user_attributes: OMIT, event_attribute: OMIT, additional_properties: nil)
+    def initialize(id:, name:, trigger:, user_attributes:, description: OMIT, badge_url: OMIT, key: OMIT, streak_length: OMIT,
+                   achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, event_attribute: OMIT, event_attributes: OMIT, additional_properties: nil)
       @id = id
       @name = name
       @trigger = trigger
@@ -86,8 +90,9 @@ def initialize(id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OM
       @metric_id = metric_id if metric_id != OMIT
       @metric_value = metric_value if metric_value != OMIT
       @metric_name = metric_name if metric_name != OMIT
-      @user_attributes = user_attributes if user_attributes != OMIT
+      @user_attributes = user_attributes
       @event_attribute = event_attribute if event_attribute != OMIT
+      @event_attributes = event_attributes if event_attributes != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
@@ -102,7 +107,8 @@ def initialize(id:, name:, trigger:, description: OMIT, badge_url: OMIT, key: OM
         "metricValue": metric_value,
         "metricName": metric_name,
         "userAttributes": user_attributes,
-        "eventAttribute": event_attribute
+        "eventAttribute": event_attribute,
+        "eventAttributes": event_attributes
       }.reject do |_k, v|
         v == OMIT
       end
@@ -136,6 +142,10 @@ def self.from_json(json_object:)
         event_attribute = parsed_json["eventAttribute"].to_json
         event_attribute = TrophyApiClient::AchievementResponseEventAttribute.from_json(json_object: event_attribute)
       end
+      event_attributes = parsed_json["eventAttributes"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementResponseEventAttributesItem.from_json(json_object: item)
+      end
       new(
         id: id,
         name: name,
@@ -150,6 +160,7 @@ def self.from_json(json_object:)
         metric_name: metric_name,
         user_attributes: user_attributes,
         event_attribute: event_attribute,
+        event_attributes: event_attributes,
         additional_properties: struct
       )
     end
@@ -179,8 +190,9 @@ def self.validate_raw(obj:)
       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.")
-      obj.user_attributes&.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
+      obj.user_attributes.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
       obj.event_attribute.nil? || TrophyApiClient::AchievementResponseEventAttribute.validate_raw(obj: obj.event_attribute)
+      obj.event_attributes&.is_a?(Array) != false || raise("Passed value for field obj.event_attributes is not the expected type, validation failed.")
     end
   end
 end

lib/trophy_api_client/types/achievement_response_event_attribute.rb

@@ -4,8 +4,8 @@
 require "json"
 
 module TrophyApiClient
-  # Event attribute filter that must be met for this achievement to be completed.
-  #  Only present if the achievement has an event filter configured.
+  # Deprecated. Event attribute filter that must be met for this achievement to be
+  #  completed. Only present if the achievement has an event filter configured.
   class AchievementResponseEventAttribute
     # @return [String] The key of the event attribute.
     attr_reader :key

lib/trophy_api_client/types/achievement_response_event_attributes_item.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AchievementResponseEventAttributesItem
+    # @return [String] The key of the event attribute.
+    attr_reader :key
+    # @return [String] The value of the event attribute.
+    attr_reader :value
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param key [String] The key of the event attribute.
+    # @param value [String] The value of the event attribute.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AchievementResponseEventAttributesItem]
+    def initialize(key:, value:, additional_properties: nil)
+      @key = key
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "key": key, "value": value }
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  AchievementResponseEventAttributesItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementResponseEventAttributesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      key = parsed_json["key"]
+      value = parsed_json["value"]
+      new(
+        key: key,
+        value: value,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AchievementResponseEventAttributesItem to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end