Automatically update Ruby SDK

Author: github-actions[bot]

.fern/metadata.json

@@ -2,7 +2,7 @@
   "cliVersion": "5.62.0",
   "generatorName": "fernapi/fern-ruby-sdk",
   "generatorVersion": "1.13.2",
-  "originGitCommit": "fc9c2289d356522ad24b9464747364dd97f31a15",
+  "originGitCommit": "e5e0764c693f384265aea6528e87792857387287",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "ciProvider": "github"

lib/gemconfig.rb

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

lib/trophy.rb

@@ -139,6 +139,9 @@
 require_relative "trophy/types/wrapped_activity"
 require_relative "trophy/types/wrapped_response"
 require_relative "trophy/types/admin_error_body"
+require_relative "trophy/types/batch_metric_event_user"
+require_relative "trophy/types/batch_metric_event"
+require_relative "trophy/types/batch_events_response"
 require_relative "trophy/types/admin_issue_severity"
 require_relative "trophy/types/admin_issue"
 require_relative "trophy/types/create_streak_freezes_response"

lib/trophy/admin/metrics/client.rb

@@ -194,6 +194,40 @@ def get(request_options: {}, **params)
             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

lib/trophy/client.rb

@@ -9,7 +9,7 @@ class Client
     # @param max_retries [Integer]
     #
     # @return [void]
-    def initialize(api_key:, base_url: nil, environment: Trophy::Environment::PRODUCTION, sdk_version: "1.18.0", max_retries: 2)
+    def initialize(api_key:, base_url: nil, environment: Trophy::Environment::PRODUCTION, sdk_version: "1.19.0", max_retries: 2)
       @base_url = base_url
       @environment = environment
 

lib/trophy/types/batch_events_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response returned when a batch of metric events is accepted.
+    class BatchEventsResponse < Internal::Types::Model
+      field :accepted, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

lib/trophy/types/batch_metric_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A metric event submitted as part of a batch. Same shape as a single metric event, with the metric key included in
+    # the body.
+    class BatchMetricEvent < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::BatchMetricEventUser }, optional: false, nullable: false
+
+      field :value, -> { Integer }, optional: false, nullable: false
+
+      field :attributes, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+
+      field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+    end
+  end
+end

lib/trophy/types/batch_metric_event_user.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user that triggered a batch metric event.
+    class BatchMetricEventUser < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :tz, -> { String }, optional: true, nullable: false
+
+      field :device_tokens, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "deviceTokens"
+
+      field :subscribe_to_emails, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "subscribeToEmails"
+
+      field :attributes, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+    end
+  end
+end

lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.18.0"
+  VERSION = "1.19.0"
 end

reference.md

@@ -2712,6 +2712,85 @@ client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">batch_events</a>(request) -> Trophy::Types::BatchEventsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Submit up to 1,000 metric events for asynchronous processing.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.admin.metrics.batch_events(request: [{
+  key: "words-written",
+  user: {
+    id: "18",
+    email: "user@example.com",
+    tz: "Europe/London",
+    attributes: {
+      department: "engineering",
+      role: "developer"
+    }
+  },
+  value: 750,
+  attributes: {
+    category: "writing",
+    source: "mobile-app"
+  },
+  idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f"
+}])
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Array[Trophy::Types::BatchMetricEvent]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Trophy::Admin::Metrics::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>