trophy_api_client 1.14.0 → 1.26.1

data/lib/trophy/admin/streaks/pauses/types/pauses_delete_request.rb

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

data/lib/trophy/admin/streaks/settings/client.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Streaks
+      module Settings
+        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
+
+          # Get the organization's streak configuration.
+          #
+          # @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::StreakSettings]
+          def get(request_options: {}, **_params)
+            request = Trophy::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:admin),
+              method: "GET",
+              path: "streaks/settings",
+              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::StreakSettings.load(response.body)
+            else
+              error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # Update the organization's streak configuration.
+          #
+          # @param request_options [Hash]
+          # @param params [Trophy::Admin::Streaks::Settings::Types::UpdateStreakSettingsRequest]
+          # @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::StreakSettings]
+          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: "streaks/settings",
+              body: Trophy::Admin::Streaks::Settings::Types::UpdateStreakSettingsRequest.new(params).to_h,
+              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::StreakSettings.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/streaks/settings/types/update_streak_settings_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Streaks
+      module Settings
+        module Types
+          class UpdateStreakSettingsRequest < Internal::Types::Model
+            field :frequency, -> { Trophy::Types::AdminStreakFrequency }, optional: true, nullable: false
+
+            field :evaluation_mode, -> { Trophy::Types::AdminStreakEvaluationMode }, optional: true, nullable: false, api_name: "evaluationMode"
+
+            field :customization_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "customizationEnabled"
+
+            field :days_off, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false, api_name: "daysOff"
+
+            field :metrics, -> { Internal::Types::Array[Trophy::Types::StreakSettingsMetric] }, optional: true, nullable: false
+
+            field :freezes, -> { Trophy::Types::UpdateStreakSettingsFreezes }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/streaks/types/reset_streaks_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Streaks
+      module Types
+        class ResetStreaksRequest < Internal::Types::Model
+          field :users, -> { Internal::Types::Array[Trophy::Admin::Streaks::Types::ResetStreaksRequestUsersItem] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/streaks/types/reset_streaks_request_users_item.rb

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

data/lib/trophy/admin/streaks/types/restore_streaks_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Streaks
+      module Types
+        class RestoreStreaksRequest < Internal::Types::Model
+          field :users, -> { Internal::Types::Array[Trophy::Admin::Streaks::Types::RestoreStreaksRequestUsersItem] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/trophy/admin/streaks/types/restore_streaks_request_users_item.rb

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

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

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Tenants
+      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 tenants in the current environment.
+        #
+        # @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::AdminTenant]]
+        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: "tenants",
+            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::ListTenantsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Create tenants.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::CreateTenantsRequest]
+        # @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::CreateTenantsResponse]
+        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: "tenants",
+            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::CreateTenantsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Delete tenants 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::DeleteTenantsResponse]
+        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: "tenants",
+            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::DeleteTenantsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Update tenants by ID.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::UpdateTenantsRequest]
+        # @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::UpdateTenantsResponse]
+        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: "tenants",
+            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::UpdateTenantsResponse.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 tenant 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::AdminTenant]
+        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: "tenants/#{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::AdminTenant.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/tenants/types/tenants_delete_request.rb

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

data/lib/trophy/admin/tenants/types/tenants_list_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Tenants
+      module Types
+        class TenantsListRequest < 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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Trophy
+  class Client
+    # @param api_key [String]
+    # @param base_url [String, nil]
+    # @param environment [Hash[Symbol, String], nil]
+    # @param sdk_version [String, nil]
+    # @param max_retries [Integer]
+    #
+    # @return [void]
+    def initialize(api_key:, base_url: nil, environment: Trophy::Environment::PRODUCTION, sdk_version: "1.26.1", max_retries: 2)
+      @base_url = base_url
+      @environment = environment
+
+      @raw_client = Trophy::Internal::Http::RawClient.new(
+        base_url: base_url || environment&.dig(:api),
+        headers: {
+          "X-Fern-Language" => "Ruby",
+          "X-API-KEY" => api_key.to_s,
+          "X-SDK-VERSION" => sdk_version.to_s
+        },
+        max_retries: max_retries
+      )
+    end
+
+    # @return [Trophy::Achievements::Client]
+    def achievements
+      @achievements ||= Trophy::Achievements::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)
+    end
+
+    # @return [Trophy::Users::Client]
+    def users
+      @users ||= Trophy::Users::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+
+    # @return [Trophy::Streaks::Client]
+    def streaks
+      @streaks ||= Trophy::Streaks::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+
+    # @return [Trophy::Points::Client]
+    def points
+      @points ||= Trophy::Points::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+
+    # @return [Trophy::Leaderboards::Client]
+    def leaderboards
+      @leaderboards ||= Trophy::Leaderboards::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+
+    # @return [Trophy::Admin::Client]
+    def admin
+      @admin ||= Trophy::Admin::Client.new(client: @raw_client, base_url: @base_url, environment: @environment)
+    end
+  end
+end

data/lib/{environment.rb → trophy/environment.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module TrophyApiClient
+module Trophy
   class Environment
     PRODUCTION = { api: "https://api.trophy.so/v1", admin: "https://admin.trophy.so/v1" }.freeze
   end

data/lib/trophy/errors/api_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class ApiError < StandardError
+    end
+  end
+end

data/lib/trophy/errors/client_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class ClientError < ResponseError
+    end
+
+    class UnauthorizedError < ClientError
+    end
+
+    class ForbiddenError < ClientError
+    end
+
+    class NotFoundError < ClientError
+    end
+  end
+end

data/lib/trophy/errors/redirect_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class RedirectError < ResponseError
+    end
+  end
+end

data/lib/trophy/errors/response_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class ResponseError < ApiError
+      attr_reader :code
+
+      def initialize(msg, code:)
+        @code = code
+        super(msg)
+      end
+
+      def inspect
+        "#<#{self.class.name} @code=#{code} @body=#{message}>"
+      end
+
+      # Returns the most appropriate error class for the given code.
+      #
+      # @return [Class]
+      def self.subclass_for_code(code)
+        case code
+        when 300..399
+          RedirectError
+        when 401
+          UnauthorizedError
+        when 403
+          ForbiddenError
+        when 404
+          NotFoundError
+        when 400..499
+          ClientError
+        when 503
+          ServiceUnavailableError
+        when 500..599
+          ServerError
+        else
+          ResponseError
+        end
+      end
+    end
+  end
+end

data/lib/trophy/errors/server_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class ServerError < ResponseError
+    end
+
+    class ServiceUnavailableError < ApiError
+    end
+  end
+end

data/lib/trophy/errors/timeout_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Errors
+    class TimeoutError < ApiError
+    end
+  end
+end

data/lib/trophy/internal/errors/constraint_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Internal
+    module Errors
+      class ConstraintError < StandardError
+      end
+    end
+  end
+end

data/lib/trophy/internal/errors/type_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Internal
+    module Errors
+      class TypeError < StandardError
+      end
+    end
+  end
+end

data/lib/trophy/internal/http/base_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Internal
+    module Http
+      # @api private
+      class BaseRequest
+        attr_reader :base_url, :path, :method, :headers, :query, :request_options
+
+        # @param base_url [String] The base URL for the request
+        # @param path [String] The path for the request
+        # @param method [String] The HTTP method for the request (:get, :post, etc.)
+        # @param headers [Hash] Additional headers for the request (optional)
+        # @param query [Hash] Query parameters for the request (optional)
+        # @param request_options [Trophy::RequestOptions, Hash{Symbol=>Object}, nil]
+        def initialize(base_url:, path:, method:, headers: {}, query: {}, request_options: {})
+          @base_url = base_url
+          @path = path
+          @method = method
+          @headers = headers
+          @query = query
+          @request_options = request_options
+        end
+
+        # @return [Hash] The query parameters merged with additional query parameters from request options.
+        def encode_query
+          additional_query = @request_options&.dig(:additional_query_parameters) || @request_options&.dig("additional_query_parameters") || {}
+          @query.merge(additional_query)
+        end
+
+        # Child classes should implement:
+        # - encode_headers: Returns the encoded HTTP request headers.
+        # - encode_body: Returns the encoded HTTP request body.
+
+        private
+
+        # Merges additional_headers from request_options into sdk_headers, filtering out
+        # any keys that collide with SDK-set or client-protected headers (case-insensitive).
+        # @param sdk_headers [Hash] Headers set by the SDK for this request type.
+        # @param protected_keys [Array<String>] Additional header keys that must not be overridden.
+        # @return [Hash] The merged headers.
+        def merge_additional_headers(sdk_headers, protected_keys: [])
+          additional_headers = @request_options&.dig(:additional_headers) || @request_options&.dig("additional_headers") || {}
+          all_protected = (sdk_headers.keys + protected_keys).to_set { |k| k.to_s.downcase }
+          filtered = additional_headers.reject { |key, _| all_protected.include?(key.to_s.downcase) }
+          sdk_headers.merge(filtered)
+        end
+      end
+    end
+  end
+end