trophy_api_client 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaadd76d0ea33bf71a01b67dc5fc89293da845a5fc13aac3c611f8f9a014193e
-  data.tar.gz: 312bf9c423fd7c7b0440cdfb778fbfeb4e31e40c6c248ae42d9ccc9f69777684
+  metadata.gz: 8b9b801a55fb30105dc70b819d3889b53c348d6aaef675847912bcf53a6180cb
+  data.tar.gz: 7cf24c43b3d632eab7ed9ae5a1acad3285af28ffc673c4b4f92b519dd7d65476
 SHA512:
-  metadata.gz: 2c471a43f6be9c95ab144195c7ae9753c09085e0cb897fd765c78850d8a15ae71d3868ae3399c84e70da7263154bdc721de7b153c0ac7d49df0cac26f8444c57
-  data.tar.gz: 10f2b7ebf51aaa9656d12aae94f442f78737ad5aaa9bac27e234ff8348c59a76c6a5ceae267f18a5a4dd5ed9bd06d1d9ea51fead937dffeb6805e9bf2a5adcc9
+  metadata.gz: 49139c5bba99b6f673a4f5065ba44e052ac8ba459237af00c29076be4cf56a9b81302d44a85dec4727973cf9f7681b6b6614486ab58d5c648796f38dc9c1b1e4
+  data.tar.gz: aa0864579a800c9c66f2e6ce9671ce04ec208f3005bb7d5f77c10ecddf86fc1b059ceffbb14b0e49f2304c940d49dcb17fdd3d24f69a6691f7deff028d64940d

data/lib/trophy/admin/client.rb

@@ -24,6 +24,11 @@ module Trophy
         @achievements ||= Trophy::Admin::Achievements::Client.new(client: @client, base_url: @base_url, environment: @environment)
       end
 
+      # @return [Trophy::Rewards::Client]
+      def rewards
+        @rewards ||= Trophy::Admin::Rewards::Client.new(client: @client, base_url: @base_url, environment: @environment)
+      end
+
       # @return [Trophy::Metrics::Client]
       def metrics
         @metrics ||= Trophy::Admin::Metrics::Client.new(client: @client, base_url: @base_url, environment: @environment)

data/lib/trophy/admin/rewards/client.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      class Client
+        # @param client [Trophy::Internal::Http::RawClient]
+        # @param base_url [String, nil]
+        # @param environment [Hash[Symbol, String], nil]
+        #
+        # @return [void]
+        def initialize(client:, base_url: nil, environment: nil)
+          @client = client
+          @base_url = base_url
+          @environment = environment
+        end
+
+        # List rewards.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [Integer, nil] :limit
+        # @option params [Integer, nil] :skip
+        #
+        # @return [Array[Trophy::Types::AdminReward]]
+        def list(request_options: {}, **params)
+          params = Trophy::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["skip"] = params[:skip] if params.key?(:skip)
+
+          request = Trophy::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+            method: "GET",
+            path: "rewards",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Trophy::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Trophy::Types::ListRewardsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Create rewards. Optionally include triggers in each reward payload to create them alongside the reward. A
+        # reward with any invalid trigger is not created.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::CreateRewardsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Trophy::Types::CreateRewardsResponse]
+        def create(request_options: {}, **params)
+          params = Trophy::Internal::Types::Utils.normalize_keys(params)
+          request = Trophy::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+            method: "POST",
+            path: "rewards",
+            body: params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Trophy::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Trophy::Types::CreateRewardsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Delete rewards by ID. Maximum 100 reward IDs per request. A deleted reward's triggers are deleted too.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String, nil] :ids
+        #
+        # @return [Trophy::Types::DeleteRewardsResponse]
+        def delete(request_options: {}, **params)
+          params = Trophy::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["ids"] = params[:ids] if params.key?(:ids)
+
+          request = Trophy::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+            method: "DELETE",
+            path: "rewards",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Trophy::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Trophy::Types::DeleteRewardsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Update rewards by ID. Maximum 100 rewards per request. Only provided fields are updated; omitted fields are
+        # preserved. Use the reward triggers endpoints to change a reward's triggers.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::UpdateRewardsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Trophy::Types::UpdateRewardsResponse]
+        def update(request_options: {}, **params)
+          params = Trophy::Internal::Types::Utils.normalize_keys(params)
+          request = Trophy::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+            method: "PATCH",
+            path: "rewards",
+            body: params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Trophy::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Trophy::Types::UpdateRewardsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Get a reward by ID.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :id
+        #
+        # @return [Trophy::Types::AdminReward]
+        def get(request_options: {}, **params)
+          params = Trophy::Internal::Types::Utils.normalize_keys(params)
+          request = Trophy::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+            method: "GET",
+            path: "rewards/#{URI.encode_uri_component(params[:id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Trophy::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Trophy::Types::AdminReward.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # @return [Trophy::Triggers::Client]
+        def triggers
+          @triggers ||= Trophy::Admin::Rewards::Triggers::Client.new(client: @client, base_url: @base_url, environment: @environment)
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/rewards/triggers/client.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      module Triggers
+        class Client
+          # @param client [Trophy::Internal::Http::RawClient]
+          # @param base_url [String, nil]
+          # @param environment [Hash[Symbol, String], nil]
+          #
+          # @return [void]
+          def initialize(client:, base_url: nil, environment: nil)
+            @client = client
+            @base_url = base_url
+            @environment = environment
+          end
+
+          # List triggers for a reward. Active triggers are listed first.
+          #
+          # @param request_options [Hash]
+          # @param params [Hash]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          # @option params [String] :reward_id
+          # @option params [Integer, nil] :limit
+          # @option params [Integer, nil] :skip
+          #
+          # @return [Array[Trophy::Types::AdminRewardTrigger]]
+          def list(request_options: {}, **params)
+            params = Trophy::Internal::Types::Utils.normalize_keys(params)
+            query_params = {}
+            query_params["limit"] = params[:limit] if params.key?(:limit)
+            query_params["skip"] = params[:skip] if params.key?(:skip)
+
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "GET",
+              path: "rewards/#{URI.encode_uri_component(params[:reward_id].to_s)}/triggers",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Trophy::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Trophy::Types::ListRewardTriggersResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Create reward triggers in bulk. Maximum 100 triggers per request.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::CreateRewardTriggersRequest]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          # @option params [String] :reward_id
+          #
+          # @return [Trophy::Types::CreateRewardTriggersResponse]
+          def create(request_options: {}, **params)
+            params = Trophy::Internal::Types::Utils.normalize_keys(params)
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "POST",
+              path: "rewards/#{URI.encode_uri_component(params[:reward_id].to_s)}/triggers",
+              body: params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Trophy::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Trophy::Types::CreateRewardTriggersResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Delete reward triggers by ID. Maximum 100 trigger IDs per request. A reward with no triggers is not awarded
+          # until a trigger is added.
+          #
+          # @param request_options [Hash]
+          # @param params [Hash]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          # @option params [String] :reward_id
+          # @option params [String, nil] :ids
+          #
+          # @return [Trophy::Types::DeleteRewardTriggersResponse]
+          def delete(request_options: {}, **params)
+            params = Trophy::Internal::Types::Utils.normalize_keys(params)
+            query_params = {}
+            query_params["ids"] = params[:ids] if params.key?(:ids)
+
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "DELETE",
+              path: "rewards/#{URI.encode_uri_component(params[:reward_id].to_s)}/triggers",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Trophy::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Trophy::Types::DeleteRewardTriggersResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Update reward triggers in bulk. Maximum 100 triggers per request. Only provided fields are updated; omitted
+          # fields are preserved. A trigger keeps its ID when its criteria change.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::UpdateRewardTriggersRequest]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          # @option params [String] :reward_id
+          #
+          # @return [Trophy::Types::UpdateRewardTriggersResponse]
+          def update(request_options: {}, **params)
+            params = Trophy::Internal::Types::Utils.normalize_keys(params)
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "PATCH",
+              path: "rewards/#{URI.encode_uri_component(params[:reward_id].to_s)}/triggers",
+              body: params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Trophy::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Trophy::Types::UpdateRewardTriggersResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Get a single reward trigger by ID.
+          #
+          # @param request_options [Hash]
+          # @param params [Hash]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          # @option params [String] :reward_id
+          # @option params [String] :id
+          #
+          # @return [Trophy::Types::AdminRewardTrigger]
+          def get(request_options: {}, **params)
+            params = Trophy::Internal::Types::Utils.normalize_keys(params)
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "GET",
+              path: "rewards/#{URI.encode_uri_component(params[:reward_id].to_s)}/triggers/#{URI.encode_uri_component(params[:id].to_s)}",
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Trophy::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Trophy::Types::AdminRewardTrigger.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/rewards/triggers/types/triggers_delete_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      module Triggers
+        module Types
+          class TriggersDeleteRequest < Internal::Types::Model
+            field :reward_id, -> { String }, optional: false, nullable: false, api_name: "rewardId"
+
+            field :ids, -> { String }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/rewards/triggers/types/triggers_list_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      module Triggers
+        module Types
+          class TriggersListRequest < Internal::Types::Model
+            field :reward_id, -> { String }, optional: false, nullable: false, api_name: "rewardId"
+
+            field :limit, -> { Integer }, optional: true, nullable: false
+
+            field :skip, -> { Integer }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/rewards/types/rewards_delete_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      module Types
+        class RewardsDeleteRequest < Internal::Types::Model
+          field :ids, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/rewards/types/rewards_list_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Rewards
+      module Types
+        class RewardsListRequest < Internal::Types::Model
+          field :limit, -> { Integer }, optional: true, nullable: false
+
+          field :skip, -> { Integer }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/trophy/client.rb

@@ -9,7 +9,7 @@ module Trophy
     # @param max_retries [Integer]
     #
     # @return [void]
-    def initialize(api_key:, base_url: nil, environment: Trophy::Environment::PRODUCTION, sdk_version: "1.27.0", max_retries: 2)
+    def initialize(api_key:, base_url: nil, environment: Trophy::Environment::PRODUCTION, sdk_version: "1.28.0", max_retries: 2)
       @base_url = base_url
       @environment = environment
 
@@ -29,6 +29,11 @@ module Trophy
       @achievements ||= Trophy::Achievements::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
     end
 
+    # @return [Trophy::Rewards::Client]
+    def rewards
+      @rewards ||= Trophy::Rewards::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+
     # @return [Trophy::Metrics::Client]
     def metrics
       @metrics ||= Trophy::Metrics::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)

data/lib/trophy/rewards/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Rewards
+    class Client
+      # @param client [Trophy::Internal::Http::RawClient]
+      # @param base_url [String, nil]
+      # @param environment [Hash[Symbol, String], nil]
+      #
+      # @return [void]
+      def initialize(client:, base_url: nil, environment: nil)
+        @client = client
+        @base_url = base_url
+        @environment = environment
+      end
+
+      # Redeem a reward for a user.
+      #
+      # @param request_options [Hash]
+      # @param params [Trophy::Rewards::Types::RewardsRedeemRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :key
+      #
+      # @return [Trophy::Types::RedeemRewardResponse]
+      def redeem(request_options: {}, **params)
+        params = Trophy::Internal::Types::Utils.normalize_keys(params)
+        request_data = Trophy::Rewards::Types::RewardsRedeemRequest.new(params).to_h
+        non_body_param_names = %w[key]
+        body = request_data.except(*non_body_param_names)
+
+        request = Trophy::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "POST",
+          path: "rewards/#{URI.encode_uri_component(params[:key].to_s)}/redeem",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Trophy::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Trophy::Types::RedeemRewardResponse.load(response.body)
+        else
+          error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/trophy/rewards/types/rewards_redeem_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Rewards
+    module Types
+      class RewardsRedeemRequest < Internal::Types::Model
+        field :key, -> { String }, optional: false, nullable: false
+
+        field :user, -> { Trophy::Types::UpsertedUser }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/trophy/types/achievement_completion_response.rb

@@ -8,6 +8,10 @@ module Trophy
       field :achievement, -> { Trophy::Types::UserAchievementResponse }, optional: false, nullable: false
 
       field :points, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventPointsResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventLeaderboardResponse] }, optional: false, nullable: false
+
+      field :rewards, -> { Internal::Types::Array[Trophy::Types::UserRewardResponse] }, optional: false, nullable: false
     end
   end
 end

data/lib/trophy/types/admin_reward.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A reward returned from the admin rewards endpoints.
+    class AdminReward < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::AdminRewardStatus }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::AdminRewardType }, optional: false, nullable: false
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :points, -> { Integer }, optional: true, nullable: false
+
+      field :max_redemptions, -> { Integer }, optional: true, nullable: false, api_name: "maxRedemptions"
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::AdminRewardUserAttributesItem] }, optional: false, nullable: false, api_name: "userAttributes"
+    end
+  end
+end

data/lib/trophy/types/admin_reward_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module AdminRewardStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      INACTIVE = "inactive"
+    end
+  end
+end