trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy/admin/leaderboards/types/leaderboards_list_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Leaderboards
+      module Types
+        class LeaderboardsListRequest < 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/admin/metrics/client.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Metrics
+      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 metrics.
+        #
+        # @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::CreatedMetric]]
+        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: "metrics",
+            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::ListMetricsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Create metrics.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::CreateMetricsRequest]
+        # @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::CreateMetricsResponse]
+        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: "metrics",
+            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::CreateMetricsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Delete metrics 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, nil] :ids
+        #
+        # @return [Trophy::Types::DeleteMetricsResponse]
+        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: "metrics",
+            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::DeleteMetricsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Update metrics by ID.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::UpdateMetricsRequest]
+        # @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::UpdateMetricsResponse]
+        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: "metrics",
+            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::UpdateMetricsResponse.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 metric 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::CreatedMetric]
+        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: "metrics/#{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::CreatedMetric.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Submit up to 1,000 metric events for asynchronous processing.
+        #
+        # @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
+        #
+        # @return [Trophy::Types::BatchEventsResponse]
+        def batch_events(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: "metrics/events",
+            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::BatchEventsResponse.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

data/lib/trophy/admin/metrics/types/metrics_delete_request.rb

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

data/lib/trophy/admin/metrics/types/metrics_list_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Metrics
+      module Types
+        class MetricsListRequest < 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/admin/points/boosts/client.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Boosts
+        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 points boosts for a system.
+          #
+          # @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] :system_id
+          # @option params [Integer, nil] :limit
+          # @option params [Integer, nil] :skip
+          #
+          # @return [Array[Trophy::Types::AdminPointsBoost]]
+          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: "points/#{URI.encode_uri_component(params[:system_id].to_s)}/boosts",
+              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::ListPointsBoostsResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Create points boosts.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::CreatePointsBoostsRequest]
+          # @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] :system_id
+          #
+          # @return [Trophy::Types::CreatePointsBoostsResponse]
+          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: "points/#{URI.encode_uri_component(params[:system_id].to_s)}/boosts",
+              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::CreatePointsBoostsResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Delete multiple points boosts 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] :system_id
+          # @option params [String, nil] :ids
+          #
+          # @return [Trophy::Types::DeletePointsBoostsResponse]
+          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: "points/#{URI.encode_uri_component(params[:system_id].to_s)}/boosts",
+              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::DeletePointsBoostsResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Update multiple points boosts.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::PatchPointsBoostsRequest]
+          # @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] :system_id
+          #
+          # @return [Trophy::Types::PatchPointsBoostsResponse]
+          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: "points/#{URI.encode_uri_component(params[:system_id].to_s)}/boosts",
+              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::PatchPointsBoostsResponse.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 points boost 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] :system_id
+          # @option params [String] :id
+          #
+          # @return [Trophy::Types::AdminPointsBoost]
+          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: "points/#{URI.encode_uri_component(params[:system_id].to_s)}/boosts/#{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::AdminPointsBoost.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/points/boosts/types/boosts_delete_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Boosts
+        module Types
+          class BoostsDeleteRequest < Internal::Types::Model
+            field :system_id, -> { String }, optional: false, nullable: false, api_name: "systemId"
+
+            field :ids, -> { String }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/points/boosts/types/boosts_list_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Boosts
+        module Types
+          class BoostsListRequest < Internal::Types::Model
+            field :system_id, -> { String }, optional: false, nullable: false, api_name: "systemId"
+
+            field :limit, -> { Integer }, optional: true, nullable: false
+
+            field :skip, -> { Integer }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      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
+
+        # @return [Trophy::Systems::Client]
+        def systems
+          @systems ||= Trophy::Admin::Points::Systems::Client.new(client: @client, base_url: @base_url, environment: @environment)
+        end
+
+        # @return [Trophy::Boosts::Client]
+        def boosts
+          @boosts ||= Trophy::Admin::Points::Boosts::Client.new(client: @client, base_url: @base_url, environment: @environment)
+        end
+
+        # @return [Trophy::Levels::Client]
+        def levels
+          @levels ||= Trophy::Admin::Points::Levels::Client.new(client: @client, base_url: @base_url, environment: @environment)
+        end
+
+        # @return [Trophy::Triggers::Client]
+        def triggers
+          @triggers ||= Trophy::Admin::Points::Triggers::Client.new(client: @client, base_url: @base_url, environment: @environment)
+        end
+      end
+    end
+  end
+end