trophy_api_client 1.14.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45068f7d5694f561b61d480fa8e8d89c556f9dfa860f75689cbcf4b4fa2098c3
-  data.tar.gz: a86937078e80ad934bcc256ea439cf3403b3ae583e3dbdd2cea5e73e72f5da64
+  metadata.gz: eaadd76d0ea33bf71a01b67dc5fc89293da845a5fc13aac3c611f8f9a014193e
+  data.tar.gz: 312bf9c423fd7c7b0440cdfb778fbfeb4e31e40c6c248ae42d9ccc9f69777684
 SHA512:
-  metadata.gz: e8fac77c390e4bc53659399927abd76957c181addeec88f300098fc04fc4a84ac5a6e48284ab00fe05e160db003ef8c9e6efa2c15d10af1bc50327539f77c6cb
-  data.tar.gz: 98a01274b0a1003797a4f1bd0f202a8aaeccc2d675be465244749a607461bd888dd825d5734c90960d0f86507b6afc07eac04cba8ffcf5d1e6ffa2fad792e01d
+  metadata.gz: 2c471a43f6be9c95ab144195c7ae9753c09085e0cb897fd765c78850d8a15ae71d3868ae3399c84e70da7263154bdc721de7b153c0ac7d49df0cac26f8444c57
+  data.tar.gz: 10f2b7ebf51aaa9656d12aae94f442f78737ad5aaa9bac27e234ff8348c59a76c6a5ceae267f18a5a4dd5ed9bd06d1d9ea51fead937dffeb6805e9bf2a5adcc9

data/.fern/metadata.json

@@ -0,0 +1,9 @@
+{
+  "cliVersion": "5.62.0",
+  "generatorName": "fernapi/fern-ruby-sdk",
+  "generatorVersion": "1.13.2",
+  "originGitCommit": "ecf3b4b5a4d81bc291b24618eb182a70526728e2",
+  "originGitCommitIsDirty": false,
+  "invokedBy": "ci",
+  "ciProvider": "github"
+}

data/.rubocop.yml

@@ -0,0 +1,103 @@
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Severity: warning
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Minitest/UselessAssertion:
+  Enabled: false
+
+# Dynamic snippets are code samples for documentation, not standalone Ruby files.
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Indent hash elements 2 spaces from the start of the enclosing line rather than
+# aligning with the preceding paren or bracket. Generated code nests hashes inside
+# arrays and method calls; the "consistent" style is more readable there.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
+# from the start of the method call's line, regardless of parenthesis position.
+# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
+# keep this config symmetric with Layout/FirstHashElementIndentation above.
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
+# derived from IR type names whose wire form contains underscores or digits.
+# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
+# disabling the cop keeps CI green without changing customer output. Fixing at
+# source would rename public types across every existing SDK and therefore
+# requires a ruby-v2 major-version bump with a generator migration.
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
+# Rubocop has an autocorrecter for this cop, but the only caller of integer
+# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
+# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
+# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
+# is excluded above), so formatting integers there would change docs/dashboard
+# output without any rubocop benefit. Disabling the cop keeps integers raw
+# everywhere and avoids customer-visible diffs.
+Style/NumericLiterals:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 3.0+
+- Bundler
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+bundle install
+```
+
+### Building
+
+Build the gem:
+
+```bash
+gem build *.gemspec
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+bundle exec rubocop
+```
+
+Fix code style issues:
+
+```bash
+bundle exec rubocop -a
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `lib/` - API client classes and types
+- Most Ruby files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/ruby-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `bundle exec rspec`
+4. Run linting: `bundle exec rubocop`
+5. Build the gem: `gem build *.gemspec`
+6. Commit your changes with a clear commit message
+7. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Trophy Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Trophy Ruby SDK
+
+The Trophy Ruby SDK provides convenient access to the Trophy API from applications written in the
+Ruby language.
+
+Trophy provides APIs and tools for adding gamification to your application, keeping users engaged
+through rewards, achievements, streaks, and personalized communication.
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. If you just want to use the
+package, just run:
+
+```bash
+gem install trophy_api_client
+```
+
+If you want to build the gem from source:
+
+```bash
+gem build trophy_api_client.gemspec
+```
+
+## Usage
+
+The package needs to be configured with your account's API key which is available in the Trophy
+dashboard.
+
+```ruby
+require 'trophy_api_client'
+include TrophyApiClient
+
+client = TrophyApiClient::Client.new(
+  api_key: 'YOUR_API_KEY'
+)
+
+result = client.metrics.event(
+  :key => 'words-written',
+  :user => {
+    :id => '18',
+    :email => 'jk.rowling@harrypotter.com'
+  },
+  :value => 750
+)
+```
+
+## Documentation
+
+See the [Trophy API Docs](https://docs.trophy.so) for more
+information on the accessible endpoints.

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require "rubocop/rake_task"
+require "bundler/gem_tasks"
+
+task default: %i[test rubocop]
+
+Rake::TestTask.new do |t|
+  t.pattern = "./test/**/test_*.rb"
+end
+
+RuboCop::RakeTask.new

data/custom.gemspec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def add_custom_gemspec_data(spec)
+  spec.name = "trophy_api_client"
+end

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.14.0"
+    VERSION = ""
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

data/lib/trophy/achievements/client.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Achievements
+    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 all achievements and their completion stats.
+      #
+      # @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] :user_attributes
+      #
+      # @return [Array[Trophy::Types::AchievementWithStatsResponse]]
+      def all(request_options: {}, **params)
+        params = Trophy::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["userAttributes"] = params[:user_attributes] if params.key?(:user_attributes)
+
+        request = Trophy::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "GET",
+          path: "achievements",
+          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
+        return if code.between?(200, 299)
+
+        error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Mark an achievement as completed for a user.
+      #
+      # @param request_options [Hash]
+      # @param params [Trophy::Achievements::Types::AchievementsCompleteRequest]
+      # @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::AchievementCompletionResponse]
+      def complete(request_options: {}, **params)
+        params = Trophy::Internal::Types::Utils.normalize_keys(params)
+        request_data = Trophy::Achievements::Types::AchievementsCompleteRequest.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: "achievements/#{URI.encode_uri_component(params[:key].to_s)}/complete",
+          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::AchievementCompletionResponse.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/achievements/types/achievements_all_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Achievements
+    module Types
+      class AchievementsAllRequest < Internal::Types::Model
+        field :user_attributes, -> { String }, optional: true, nullable: false, api_name: "userAttributes"
+      end
+    end
+  end
+end

data/lib/trophy/achievements/types/achievements_complete_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Achievements
+    module Types
+      class AchievementsCompleteRequest < 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/admin/achievements/client.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Admin
+    module Achievements
+      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 achievements.
+        #
+        # @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::AdminAchievement]]
+        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: "achievements",
+            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::ListAchievementsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Create achievements. Trigger-specific fields are required based on `trigger`.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::CreateAchievementsRequest]
+        # @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::CreateAchievementsResponse]
+        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: "achievements",
+            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::CreateAchievementsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Delete achievements 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::DeleteAchievementsResponse]
+        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: "achievements",
+            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::DeleteAchievementsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Update achievements by ID. Maximum 100 achievements per request. Only provided fields are updated; omitted
+        # fields are preserved.
+        #
+        # @param request_options [Hash]
+        # @param params [Trophy::Types::UpdateAchievementsRequest]
+        # @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::UpdateAchievementsResponse]
+        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: "achievements",
+            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::UpdateAchievementsResponse.load(response.body)
+          else
+            error_class = Trophy::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Get an achievement 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::AdminAchievement]
+        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: "achievements/#{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::AdminAchievement.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/achievements/types/achievements_delete_request.rb

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