Automatically update Ruby SDK

Author: github-actions[bot]

lib/gemconfig.rb

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

lib/trophy_api_client/admin/streaks/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
+require_relative "types/restore_streaks_request_users_item"
 require_relative "../../types/restore_streaks_response"
 require "async"
 
@@ -20,7 +21,8 @@ def initialize(request_client:)
       #  the case of daily streaks), one year (in the case of weekly streaks), or two
       #  years (in the case of monthly streaks).
       #
-      # @param user_ids [Array<String>] Array of user IDs to restore streaks for. Maximum 100 users per request.
+      # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
+      #   * :id (String)
       # @param request_options [TrophyApiClient::RequestOptions]
       # @return [TrophyApiClient::RestoreStreaksResponse]
       # @example
@@ -29,8 +31,8 @@ def initialize(request_client:)
       #    environment: TrophyApiClient::Environment::PRODUCTION,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.admin.streaks.restore(user_ids: ["user-123", "user-456"])
-      def restore(user_ids:, request_options: nil)
+      #  api.admin.streaks.restore(users: [{ id: "user-123" }, { id: "user-456" }])
+      def restore(users:, request_options: nil)
         response = @request_client.conn.post 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?
@@ -42,7 +44,7 @@ def restore(user_ids:, request_options: nil)
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
           end
-          req.body = { **(request_options&.additional_body_parameters || {}), userIds: user_ids }.compact
+          req.body = { **(request_options&.additional_body_parameters || {}), users: users }.compact
           req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
         end
         TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)
@@ -63,7 +65,8 @@ def initialize(request_client:)
       #  the case of daily streaks), one year (in the case of weekly streaks), or two
       #  years (in the case of monthly streaks).
       #
-      # @param user_ids [Array<String>] Array of user IDs to restore streaks for. Maximum 100 users per request.
+      # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
+      #   * :id (String)
       # @param request_options [TrophyApiClient::RequestOptions]
       # @return [TrophyApiClient::RestoreStreaksResponse]
       # @example
@@ -72,8 +75,8 @@ def initialize(request_client:)
       #    environment: TrophyApiClient::Environment::PRODUCTION,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.admin.streaks.restore(user_ids: ["user-123", "user-456"])
-      def restore(user_ids:, request_options: nil)
+      #  api.admin.streaks.restore(users: [{ id: "user-123" }, { id: "user-456" }])
+      def restore(users:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -86,7 +89,7 @@ def restore(user_ids:, request_options: nil)
             unless request_options.nil? || request_options&.additional_query_parameters.nil?
               req.params = { **(request_options&.additional_query_parameters || {}) }.compact
             end
-            req.body = { **(request_options&.additional_body_parameters || {}), userIds: user_ids }.compact
+            req.body = { **(request_options&.additional_body_parameters || {}), users: users }.compact
             req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
           end
           TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)

lib/trophy_api_client/admin/streaks/types/restore_streaks_request_users_item.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  module Admin
+    class Streaks
+      class RestoreStreaksRequestUsersItem
+        # @return [String] The ID of the user to restore streaks for.
+        attr_reader :id
+        # @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 user to restore streaks for.
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem]
+        def initialize(id:, additional_properties: nil)
+          @id = id
+          @additional_properties = additional_properties
+          @_field_set = { "id": id }
+        end
+
+        # Deserialize a JSON object to an instance of RestoreStreaksRequestUsersItem
+        #
+        # @param json_object [String]
+        # @return [TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          id = parsed_json["id"]
+          new(id: id, additional_properties: struct)
+        end
+
+        # Serialize an instance of RestoreStreaksRequestUsersItem 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.")
+        end
+      end
+    end
+  end
+end

lib/trophy_api_client/types/achievement_completion_response.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "achievement_completion_response_achievement"
+require_relative "user_achievement_response"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   class AchievementCompletionResponse
     # @return [String] The unique ID of the completion.
     attr_reader :completion_id
-    # @return [TrophyApiClient::AchievementCompletionResponseAchievement]
+    # @return [TrophyApiClient::UserAchievementResponse]
     attr_reader :achievement
     # @return [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
@@ -22,7 +22,7 @@ class AchievementCompletionResponse
     OMIT = Object.new
 
     # @param completion_id [String] The unique ID of the completion.
-    # @param achievement [TrophyApiClient::AchievementCompletionResponseAchievement]
+    # @param achievement [TrophyApiClient::UserAchievementResponse]
     # @param points [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -47,7 +47,7 @@ def self.from_json(json_object:)
         achievement = nil
       else
         achievement = parsed_json["achievement"].to_json
-        achievement = TrophyApiClient::AchievementCompletionResponseAchievement.from_json(json_object: achievement)
+        achievement = TrophyApiClient::UserAchievementResponse.from_json(json_object: achievement)
       end
       points = parsed_json["points"]&.transform_values do |value|
         value = value.to_json
@@ -76,7 +76,7 @@ def to_json(*_args)
     # @return [Void]
     def self.validate_raw(obj:)
       obj.completion_id.is_a?(String) != false || raise("Passed value for field obj.completion_id is not the expected type, validation failed.")
-      TrophyApiClient::AchievementCompletionResponseAchievement.validate_raw(obj: obj.achievement)
+      TrophyApiClient::UserAchievementResponse.validate_raw(obj: obj.achievement)
       obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
     end
   end

lib/trophy_api_client/types/achievement_response.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "achievement_response_trigger"
+require_relative "achievement_response_user_attributes_item"
+require_relative "achievement_response_event_attribute"
 require "ostruct"
 require "json"
 
@@ -31,6 +33,12 @@ class AchievementResponse
     # @return [String] The name of the metric associated with this achievement (only applicable if
     #  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.
+    attr_reader :event_attribute
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -54,20 +62,26 @@ class AchievementResponse
     #  trigger = 'metric')
     # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementResponse]
-    def initialize(id:, name:, trigger:, key:, description: OMIT, badge_url: OMIT, streak_length: OMIT,
-                   metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+    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)
       @id = id
       @name = name
       @trigger = trigger
       @description = description if description != OMIT
       @badge_url = badge_url if badge_url != OMIT
-      @key = key
+      @key = key if key != OMIT
       @streak_length = streak_length if streak_length != 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
+      @user_attributes = user_attributes if user_attributes != OMIT
+      @event_attribute = event_attribute if event_attribute != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
@@ -79,7 +93,9 @@ def initialize(id:, name:, trigger:, key:, description: OMIT, badge_url: OMIT, s
         "streakLength": streak_length,
         "metricId": metric_id,
         "metricValue": metric_value,
-        "metricName": metric_name
+        "metricName": metric_name,
+        "userAttributes": user_attributes,
+        "eventAttribute": event_attribute
       }.reject do |_k, v|
         v == OMIT
       end
@@ -102,6 +118,16 @@ def self.from_json(json_object:)
       metric_id = parsed_json["metricId"]
       metric_value = parsed_json["metricValue"]
       metric_name = parsed_json["metricName"]
+      user_attributes = parsed_json["userAttributes"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementResponseUserAttributesItem.from_json(json_object: item)
+      end
+      if parsed_json["eventAttribute"].nil?
+        event_attribute = nil
+      else
+        event_attribute = parsed_json["eventAttribute"].to_json
+        event_attribute = TrophyApiClient::AchievementResponseEventAttribute.from_json(json_object: event_attribute)
+      end
       new(
         id: id,
         name: name,
@@ -113,6 +139,8 @@ def self.from_json(json_object:)
         metric_id: metric_id,
         metric_value: metric_value,
         metric_name: metric_name,
+        user_attributes: user_attributes,
+        event_attribute: event_attribute,
         additional_properties: struct
       )
     end
@@ -136,11 +164,13 @@ def self.validate_raw(obj:)
       obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger 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.key.is_a?(String) != false || raise("Passed value for field obj.key 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.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.event_attribute.nil? || TrophyApiClient::AchievementResponseEventAttribute.validate_raw(obj: obj.event_attribute)
     end
   end
 end

…t_with_stats_response_event_attribute.rb …/achievement_response_event_attribute.rblib/trophy_api_client/types/achievement_with_stats_response_event_attribute.rb renamed to lib/trophy_api_client/types/achievement_response_event_attribute.rb lib/trophy_api_client/types/achievement_with_stats_response_event_attribute.rb renamed to lib/trophy_api_client/types/achievement_response_event_attribute.rb

@@ -6,7 +6,7 @@
 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.
-  class AchievementWithStatsResponseEventAttribute
+  class AchievementResponseEventAttribute
     # @return [String] The key of the event attribute.
     attr_reader :key
     # @return [String] The value of the event attribute.
@@ -22,19 +22,18 @@ class AchievementWithStatsResponseEventAttribute
     # @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::AchievementWithStatsResponseEventAttribute]
+    # @return [TrophyApiClient::AchievementResponseEventAttribute]
     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
-    #  AchievementWithStatsResponseEventAttribute
+    # Deserialize a JSON object to an instance of AchievementResponseEventAttribute
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::AchievementWithStatsResponseEventAttribute]
+    # @return [TrophyApiClient::AchievementResponseEventAttribute]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -47,8 +46,7 @@ def self.from_json(json_object:)
       )
     end
 
-    # Serialize an instance of AchievementWithStatsResponseEventAttribute to a JSON
-    #  object
+    # Serialize an instance of AchievementResponseEventAttribute to a JSON object
     #
     # @return [String]
     def to_json(*_args)

…h_stats_response_user_attributes_item.rb …evement_response_user_attributes_item.rblib/trophy_api_client/types/achievement_with_stats_response_user_attributes_item.rb renamed to lib/trophy_api_client/types/achievement_response_user_attributes_item.rb lib/trophy_api_client/types/achievement_with_stats_response_user_attributes_item.rb renamed to lib/trophy_api_client/types/achievement_response_user_attributes_item.rb

@@ -4,7 +4,7 @@
 require "json"
 
 module TrophyApiClient
-  class AchievementWithStatsResponseUserAttributesItem
+  class AchievementResponseUserAttributesItem
     # @return [String] The key of the user attribute.
     attr_reader :key
     # @return [String] The value of the user attribute.
@@ -20,7 +20,7 @@ class AchievementWithStatsResponseUserAttributesItem
     # @param key [String] The key of the user attribute.
     # @param value [String] The value of the user attribute.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::AchievementWithStatsResponseUserAttributesItem]
+    # @return [TrophyApiClient::AchievementResponseUserAttributesItem]
     def initialize(key:, value:, additional_properties: nil)
       @key = key
       @value = value
@@ -29,10 +29,10 @@ def initialize(key:, value:, additional_properties: nil)
     end
 
     # Deserialize a JSON object to an instance of
-    #  AchievementWithStatsResponseUserAttributesItem
+    #  AchievementResponseUserAttributesItem
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::AchievementWithStatsResponseUserAttributesItem]
+    # @return [TrophyApiClient::AchievementResponseUserAttributesItem]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -45,8 +45,7 @@ def self.from_json(json_object:)
       )
     end
 
-    # Serialize an instance of AchievementWithStatsResponseUserAttributesItem to a
-    #  JSON object
+    # Serialize an instance of AchievementResponseUserAttributesItem to a JSON object
     #
     # @return [String]
     def to_json(*_args)