trophy_api_client 1.14.0 → 1.27.0

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

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Levels
+        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 levels 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::AdminPointsLevel]]
+          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)}/levels",
+              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::ListPointsLevelsResponse.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 levels.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::CreatePointsLevelsRequest]
+          # @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::CreatePointsLevelsResponse]
+          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)}/levels",
+              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::CreatePointsLevelsResponse.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 levels 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::DeletePointsLevelsResponse]
+          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)}/levels",
+              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::DeletePointsLevelsResponse.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 levels. Each item must include an ID. `key` cannot be changed.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::PatchPointsLevelsRequest]
+          # @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::PatchPointsLevelsResponse]
+          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)}/levels",
+              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::PatchPointsLevelsResponse.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 level 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::AdminPointsLevel]
+          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)}/levels/#{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::AdminPointsLevel.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/levels/types/levels_delete_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Levels
+        module Types
+          class LevelsDeleteRequest < 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/levels/types/levels_list_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Levels
+        module Types
+          class LevelsListRequest < 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/systems/client.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Points
+      module Systems
+        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 systems.
+          #
+          # @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::AdminPointsSystem]]
+          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",
+              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::ListPointsSystemsResponse.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 systems. Optionally include sub-entities (levels, boosts, triggers) in each system payload to
+          # create them alongside the system.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::CreatePointsSystemsRequest]
+          # @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::CreatePointsSystemsResponse]
+          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",
+              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::CreatePointsSystemsResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Delete points systems 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::DeletePointsSystemsResponse]
+          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",
+              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::DeletePointsSystemsResponse.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Update points systems by ID.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Types::UpdatePointsSystemsRequest]
+          # @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::UpdatePointsSystemsResponse]
+          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",
+              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::UpdatePointsSystemsResponse.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 points system 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::AdminPointsSystem]
+          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[: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::AdminPointsSystem.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/systems/types/systems_delete_request.rb

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

data/lib/trophy/admin/points/systems/types/systems_list_request.rb

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