trophy_api_client 1.0.29 → 1.0.30

data/lib/trophy_api_client/types/webhooks_leaderboard_rank_changed_payload.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "webhook_user_leaderboard_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksLeaderboardRankChangedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user whose rank changed.
+    attr_reader :user
+    # @return [TrophyApiClient::WebhookUserLeaderboardResponse] The user's leaderboard data that changed.
+    attr_reader :leaderboard
+    # @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 rank changed.
+    # @param leaderboard [TrophyApiClient::WebhookUserLeaderboardResponse] The user's leaderboard data that changed.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksLeaderboardRankChangedPayload]
+    def initialize(type:, user:, leaderboard:, additional_properties: nil)
+      @type = type
+      @user = user
+      @leaderboard = leaderboard
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "leaderboard": leaderboard }
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  WebhooksLeaderboardRankChangedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksLeaderboardRankChangedPayload]
+    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["leaderboard"].nil?
+        leaderboard = nil
+      else
+        leaderboard = parsed_json["leaderboard"].to_json
+        leaderboard = TrophyApiClient::WebhookUserLeaderboardResponse.from_json(json_object: leaderboard)
+      end
+      new(
+        type: type,
+        user: user,
+        leaderboard: leaderboard,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksLeaderboardRankChangedPayload 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::WebhookUserLeaderboardResponse.validate_raw(obj: obj.leaderboard)
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_leaderboard_started_payload.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "leaderboard_response_with_rankings"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksLeaderboardStartedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::LeaderboardResponseWithRankings] The leaderboard run that started and its initial rankings.
+    attr_reader :leaderboard
+    # @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 leaderboard [TrophyApiClient::LeaderboardResponseWithRankings] The leaderboard run that started and its initial rankings.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksLeaderboardStartedPayload]
+    def initialize(type:, leaderboard:, additional_properties: nil)
+      @type = type
+      @leaderboard = leaderboard
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "leaderboard": leaderboard }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksLeaderboardStartedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksLeaderboardStartedPayload]
+    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["leaderboard"].nil?
+        leaderboard = nil
+      else
+        leaderboard = parsed_json["leaderboard"].to_json
+        leaderboard = TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: leaderboard)
+      end
+      new(
+        type: type,
+        leaderboard: leaderboard,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksLeaderboardStartedPayload 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::LeaderboardResponseWithRankings.validate_raw(obj: obj.leaderboard)
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_points_changed_payload.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "get_user_points_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksPointsChangedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user whose points increased or decreased.
+    attr_reader :user
+    # @return [TrophyApiClient::GetUserPointsResponse] The user's points after the event.
+    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 type [String] The webhook event type.
+    # @param user [TrophyApiClient::User] The user whose points increased or decreased.
+    # @param points [TrophyApiClient::GetUserPointsResponse] The user's points after the event.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksPointsChangedPayload]
+    def initialize(type:, user:, points:, additional_properties: nil)
+      @type = type
+      @user = user
+      @points = points
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "points": points }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksPointsChangedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksPointsChangedPayload]
+    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::GetUserPointsResponse.from_json(json_object: points)
+      end
+      new(
+        type: type,
+        user: user,
+        points: points,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksPointsChangedPayload 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::GetUserPointsResponse.validate_raw(obj: obj.points)
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_streak_extended_payload.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "base_streak_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksStreakExtendedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user who extended the streak.
+    attr_reader :user
+    # @return [TrophyApiClient::BaseStreakResponse] The streak that was extended.
+    attr_reader :streak
+    # @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 who extended the streak.
+    # @param streak [TrophyApiClient::BaseStreakResponse] The streak that was extended.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksStreakExtendedPayload]
+    def initialize(type:, user:, streak:, additional_properties: nil)
+      @type = type
+      @user = user
+      @streak = streak
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "streak": streak }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksStreakExtendedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksStreakExtendedPayload]
+    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["streak"].nil?
+        streak = nil
+      else
+        streak = parsed_json["streak"].to_json
+        streak = TrophyApiClient::BaseStreakResponse.from_json(json_object: streak)
+      end
+      new(
+        type: type,
+        user: user,
+        streak: streak,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksStreakExtendedPayload 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::BaseStreakResponse.validate_raw(obj: obj.streak)
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_streak_freeze_consumed_payload.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksStreakFreezeConsumedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user whose streak freeze was consumed.
+    attr_reader :user
+    # @return [Integer] The number of freezes consumed.
+    attr_reader :consumed
+    # @return [Integer] The total number of freezes the user has left after the consumption.
+    attr_reader :freezes
+    # @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 streak freeze was consumed.
+    # @param consumed [Integer] The number of freezes consumed.
+    # @param freezes [Integer] The total number of freezes the user has left after the consumption.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksStreakFreezeConsumedPayload]
+    def initialize(type:, user:, consumed:, freezes:, additional_properties: nil)
+      @type = type
+      @user = user
+      @consumed = consumed
+      @freezes = freezes
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "consumed": consumed, "freezes": freezes }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksStreakFreezeConsumedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksStreakFreezeConsumedPayload]
+    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
+      consumed = parsed_json["consumed"]
+      freezes = parsed_json["freezes"]
+      new(
+        type: type,
+        user: user,
+        consumed: consumed,
+        freezes: freezes,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksStreakFreezeConsumedPayload 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)
+      obj.consumed.is_a?(Integer) != false || raise("Passed value for field obj.consumed is not the expected type, validation failed.")
+      obj.freezes.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksStreakFreezeEarnedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user who earned streak freezes.
+    attr_reader :user
+    # @return [Integer] The number of freezes earned.
+    attr_reader :earned
+    # @return [Integer] The total number of freezes the user has after the event.
+    attr_reader :freezes
+    # @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 who earned streak freezes.
+    # @param earned [Integer] The number of freezes earned.
+    # @param freezes [Integer] The total number of freezes the user has after the event.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksStreakFreezeEarnedPayload]
+    def initialize(type:, user:, earned:, freezes:, additional_properties: nil)
+      @type = type
+      @user = user
+      @earned = earned
+      @freezes = freezes
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "earned": earned, "freezes": freezes }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksStreakFreezeEarnedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksStreakFreezeEarnedPayload]
+    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
+      earned = parsed_json["earned"]
+      freezes = parsed_json["freezes"]
+      new(
+        type: type,
+        user: user,
+        earned: earned,
+        freezes: freezes,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksStreakFreezeEarnedPayload 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)
+      obj.earned.is_a?(Integer) != false || raise("Passed value for field obj.earned is not the expected type, validation failed.")
+      obj.freezes.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_streak_lost_payload.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksStreakLostPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user who lost the streak.
+    attr_reader :user
+    # @return [Integer] The length of the streak that was lost.
+    attr_reader :length
+    # @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 who lost the streak.
+    # @param length [Integer] The length of the streak that was lost.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksStreakLostPayload]
+    def initialize(type:, user:, length:, additional_properties: nil)
+      @type = type
+      @user = user
+      @length = length
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "length": length }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksStreakLostPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksStreakLostPayload]
+    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
+      length = parsed_json["length"]
+      new(
+        type: type,
+        user: user,
+        length: length,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksStreakLostPayload 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)
+      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/webhooks_streak_started_payload.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "base_streak_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class WebhooksStreakStartedPayload
+    # @return [String] The webhook event type.
+    attr_reader :type
+    # @return [TrophyApiClient::User] The user who started the streak.
+    attr_reader :user
+    # @return [TrophyApiClient::BaseStreakResponse] The streak that was started.
+    attr_reader :streak
+    # @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 who started the streak.
+    # @param streak [TrophyApiClient::BaseStreakResponse] The streak that was started.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WebhooksStreakStartedPayload]
+    def initialize(type:, user:, streak:, additional_properties: nil)
+      @type = type
+      @user = user
+      @streak = streak
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "user": user, "streak": streak }
+    end
+
+    # Deserialize a JSON object to an instance of WebhooksStreakStartedPayload
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WebhooksStreakStartedPayload]
+    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["streak"].nil?
+        streak = nil
+      else
+        streak = parsed_json["streak"].to_json
+        streak = TrophyApiClient::BaseStreakResponse.from_json(json_object: streak)
+      end
+      new(
+        type: type,
+        user: user,
+        streak: streak,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebhooksStreakStartedPayload 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::BaseStreakResponse.validate_raw(obj: obj.streak)
+    end
+  end
+end