userplex 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5304abd79a996fe4c2eca502d4efc7d2cd728ddcc2b2acd0c6c59db0a53073b
-  data.tar.gz: 35d16d6377019940f876c2014c8907daf324f1e06bd08e2726d7f80d8a3d6599
+  metadata.gz: 9278b955d15f31b3a6584f80a78b5d75fba4d6202e72d777a763beeea2f16472
+  data.tar.gz: 57c4ca2e8a0a1493d9b28e29669f4f756c70a8cdf74c93867fcf45015bcf55d9
 SHA512:
-  metadata.gz: 210655d52b74a4d677c39a61550c8a9e128bb00bb1508453a8618c3c5727770d5be8b7458dfc19afdb288f59dc4954596368da39a149d15f73166b5852fcdfd3
-  data.tar.gz: ce1b2b1c236ecdbdd419c864cda24d786c2bf098b204096e3b6c480a9f110e2dd8409d1d0436d34696bf20fa834b1ab19add9c987eec5ed1d7e70cf74baf056f
+  metadata.gz: '002386a33fc5fd3a1b48af9f754974056cce27e4860604afb9f4edca9d85fc3189923694c1d6262ef56bd07b430c3f67329841a25a2d2e22794df77e849bec21'
+  data.tar.gz: 390655b679cbe659c7626a501054ca25c836bee3e6d96d65e14f8222bf41f2fe70322f9ebcbe79531d65120a65694176d71081795fa24c3295dcb77344a8ad4c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.15.0 (2026-01-06)
+
+Full Changelog: [v0.14.0...v0.15.0](https://github.com/dqnamo/userplex-ruby/compare/v0.14.0...v0.15.0)
+
+### Features
+
+* **api:** manual updates ([c04700c](https://github.com/dqnamo/userplex-ruby/commit/c04700c7a9731ed3995d988c8ecfc191ae2d1c85))
+
 ## 0.14.0 (2026-01-06)
 
 Full Changelog: [v0.13.0...v0.14.0](https://github.com/dqnamo/userplex-ruby/compare/v0.13.0...v0.14.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "userplex", "~> 0.14.0"
+gem "userplex", "~> 0.15.0"
 ```
 
 <!-- x-release-please-end -->
@@ -30,7 +30,7 @@ userplex = Userplex::Client.new(
   api_key: ENV["USERPLEX_API_KEY"] # This is the default and can be omitted
 )
 
-response = userplex.users.identify
+response = userplex.events.capture
 
 puts(response.success)
 ```
@@ -41,7 +41,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  user = userplex.users.identify
+  event = userplex.events.capture
 rescue Userplex::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -84,7 +84,7 @@ userplex = Userplex::Client.new(
 )
 
 # Or, configure per-request:
-userplex.users.identify(request_options: {max_retries: 5})
+userplex.events.capture(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -98,7 +98,7 @@ userplex = Userplex::Client.new(
 )
 
 # Or, configure per-request:
-userplex.users.identify(request_options: {timeout: 5})
+userplex.events.capture(request_options: {timeout: 5})
 ```
 
 On timeout, `Userplex::Errors::APITimeoutError` is raised.
@@ -129,7 +129,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 response =
-  userplex.users.identify(
+  userplex.events.capture(
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -175,18 +175,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-userplex.users.identify
+userplex.events.capture
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-userplex.users.identify
+userplex.events.capture
 
 # You can also splat a full Params class:
-params = Userplex::UserIdentifyParams.new
-userplex.users.identify(**params)
+params = Userplex::EventCaptureParams.new
+userplex.events.capture(**params)
 ```
 
 ## Versioning

data/lib/userplex/client.rb

@@ -19,12 +19,12 @@ module Userplex
     # @return [String]
     attr_reader :api_key
 
+    # @return [Userplex::Resources::Events]
+    attr_reader :events
+
     # @return [Userplex::Resources::Users]
     attr_reader :users
 
-    # @return [Userplex::Resources::Logs]
-    attr_reader :logs
-
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -73,8 +73,8 @@ module Userplex
         max_retry_delay: max_retry_delay
       )
 
+      @events = Userplex::Resources::Events.new(client: self)
       @users = Userplex::Resources::Users.new(client: self)
-      @logs = Userplex::Resources::Logs.new(client: self)
     end
   end
 end

data/lib/userplex/internal/type/base_model.rb

@@ -438,8 +438,8 @@ module Userplex
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `user_identify_response` is a `Userplex::Models::UserIdentifyResponse`
-        #   user_identify_response => {
+        #   # `event_capture_response` is a `Userplex::Models::EventCaptureResponse`
+        #   event_capture_response => {
         #     success: success
         #   }
         def deconstruct_keys(keys)

data/lib/userplex/models/event_capture_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Models
+    # @see Userplex::Resources::Events#capture
+    class EventCaptureParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :data, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
+
+      # @!attribute timestamp
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!attribute user_id
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #   @param name [String]
+      #   @param data [Hash{Symbol=>Object, nil}]
+      #   @param timestamp [Time]
+      #   @param user_id [String]
+      #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/userplex/models/event_capture_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Models
+    # @see Userplex::Resources::Events#capture
+    class EventCaptureResponse < Userplex::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Userplex::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/userplex/models.rb

@@ -39,5 +39,7 @@ module Userplex
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  EventCaptureParams = Userplex::Models::EventCaptureParams
+
   UserIdentifyParams = Userplex::Models::UserIdentifyParams
 end

data/lib/userplex/resources/events.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Resources
+    class Events
+      # Capture an event
+      #
+      # @overload capture(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #
+      # @param name [String]
+      # @param data [Hash{Symbol=>Object, nil}]
+      # @param timestamp [Time]
+      # @param user_id [String]
+      # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Userplex::Models::EventCaptureResponse]
+      #
+      # @see Userplex::Models::EventCaptureParams
+      def capture(params)
+        parsed, options = Userplex::EventCaptureParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "capture",
+          body: parsed,
+          model: Userplex::Models::EventCaptureResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Userplex::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/userplex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Userplex
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/lib/userplex.rb

@@ -52,8 +52,10 @@ require_relative "userplex/errors"
 require_relative "userplex/internal/transport/base_client"
 require_relative "userplex/internal/transport/pooled_net_requester"
 require_relative "userplex/client"
+require_relative "userplex/models/event_capture_params"
+require_relative "userplex/models/event_capture_response"
 require_relative "userplex/models/user_identify_params"
 require_relative "userplex/models/user_identify_response"
 require_relative "userplex/models"
-require_relative "userplex/resources/logs"
+require_relative "userplex/resources/events"
 require_relative "userplex/resources/users"

data/rbi/userplex/client.rbi

@@ -14,12 +14,12 @@ module Userplex
     sig { returns(String) }
     attr_reader :api_key
 
+    sig { returns(Userplex::Resources::Events) }
+    attr_reader :events
+
     sig { returns(Userplex::Resources::Users) }
     attr_reader :users
 
-    sig { returns(Userplex::Resources::Logs) }
-    attr_reader :logs
-
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/userplex/models/event_capture_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Userplex
+  module Models
+    class EventCaptureParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Userplex::EventCaptureParams, Userplex::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
+      attr_reader :data
+
+      sig { params(data: T::Hash[Symbol, T.nilable(T.anything)]).void }
+      attr_writer :data
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: Time).void }
+      attr_writer :timestamp
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      sig do
+        params(
+          name: String,
+          data: T::Hash[Symbol, T.nilable(T.anything)],
+          timestamp: Time,
+          user_id: String,
+          request_options: Userplex::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        name:,
+        data: nil,
+        timestamp: nil,
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            data: T::Hash[Symbol, T.nilable(T.anything)],
+            timestamp: Time,
+            user_id: String,
+            request_options: Userplex::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/userplex/models/event_capture_response.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Userplex
+  module Models
+    class EventCaptureResponse < Userplex::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Userplex::Models::EventCaptureResponse,
+            Userplex::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(success:)
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/userplex/models.rbi

@@ -1,5 +1,7 @@
 # typed: strong
 
 module Userplex
+  EventCaptureParams = Userplex::Models::EventCaptureParams
+
   UserIdentifyParams = Userplex::Models::UserIdentifyParams
 end

data/rbi/userplex/resources/events.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Userplex
+  module Resources
+    class Events
+      # Capture an event
+      sig do
+        params(
+          name: String,
+          data: T::Hash[Symbol, T.nilable(T.anything)],
+          timestamp: Time,
+          user_id: String,
+          request_options: Userplex::RequestOptions::OrHash
+        ).returns(Userplex::Models::EventCaptureResponse)
+      end
+      def capture(
+        name:,
+        data: nil,
+        timestamp: nil,
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Userplex::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/userplex/client.rbs

@@ -10,9 +10,9 @@ module Userplex
 
     attr_reader api_key: String
 
-    attr_reader users: Userplex::Resources::Users
+    attr_reader events: Userplex::Resources::Events
 
-    attr_reader logs: Userplex::Resources::Logs
+    attr_reader users: Userplex::Resources::Users
 
     private def auth_headers: -> ::Hash[String, String]
 

data/sig/userplex/models/event_capture_params.rbs

@@ -0,0 +1,47 @@
+module Userplex
+  module Models
+    type event_capture_params =
+      {
+        name: String,
+        data: ::Hash[Symbol, top?],
+        timestamp: Time,
+        user_id: String
+      }
+      & Userplex::Internal::Type::request_parameters
+
+    class EventCaptureParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_reader data: ::Hash[Symbol, top?]?
+
+      def data=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?]
+
+      attr_reader timestamp: Time?
+
+      def timestamp=: (Time) -> Time
+
+      attr_reader user_id: String?
+
+      def user_id=: (String) -> String
+
+      def initialize: (
+        name: String,
+        ?data: ::Hash[Symbol, top?],
+        ?timestamp: Time,
+        ?user_id: String,
+        ?request_options: Userplex::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        data: ::Hash[Symbol, top?],
+        timestamp: Time,
+        user_id: String,
+        request_options: Userplex::RequestOptions
+      }
+    end
+  end
+end

data/sig/userplex/models/event_capture_response.rbs

@@ -0,0 +1,13 @@
+module Userplex
+  module Models
+    type event_capture_response = { success: bool }
+
+    class EventCaptureResponse < Userplex::Internal::Type::BaseModel
+      attr_accessor success: bool
+
+      def initialize: (success: bool) -> void
+
+      def to_hash: -> { success: bool }
+    end
+  end
+end

data/sig/userplex/models.rbs

@@ -1,3 +1,5 @@
 module Userplex
+  class EventCaptureParams = Userplex::Models::EventCaptureParams
+
   class UserIdentifyParams = Userplex::Models::UserIdentifyParams
 end

data/sig/userplex/resources/events.rbs

@@ -0,0 +1,15 @@
+module Userplex
+  module Resources
+    class Events
+      def capture: (
+        name: String,
+        ?data: ::Hash[Symbol, top?],
+        ?timestamp: Time,
+        ?user_id: String,
+        ?request_options: Userplex::request_opts
+      ) -> Userplex::Models::EventCaptureResponse
+
+      def initialize: (client: Userplex::Client) -> void
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userplex
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Userplex
@@ -55,10 +55,12 @@ files:
 - lib/userplex/internal/type/unknown.rb
 - lib/userplex/internal/util.rb
 - lib/userplex/models.rb
+- lib/userplex/models/event_capture_params.rb
+- lib/userplex/models/event_capture_response.rb
 - lib/userplex/models/user_identify_params.rb
 - lib/userplex/models/user_identify_response.rb
 - lib/userplex/request_options.rb
-- lib/userplex/resources/logs.rb
+- lib/userplex/resources/events.rb
 - lib/userplex/resources/users.rb
 - lib/userplex/version.rb
 - manifest.yaml
@@ -81,10 +83,12 @@ files:
 - rbi/userplex/internal/type/unknown.rbi
 - rbi/userplex/internal/util.rbi
 - rbi/userplex/models.rbi
+- rbi/userplex/models/event_capture_params.rbi
+- rbi/userplex/models/event_capture_response.rbi
 - rbi/userplex/models/user_identify_params.rbi
 - rbi/userplex/models/user_identify_response.rbi
 - rbi/userplex/request_options.rbi
-- rbi/userplex/resources/logs.rbi
+- rbi/userplex/resources/events.rbi
 - rbi/userplex/resources/users.rbi
 - rbi/userplex/version.rbi
 - sig/userplex/client.rbs
@@ -106,10 +110,12 @@ files:
 - sig/userplex/internal/type/unknown.rbs
 - sig/userplex/internal/util.rbs
 - sig/userplex/models.rbs
+- sig/userplex/models/event_capture_params.rbs
+- sig/userplex/models/event_capture_response.rbs
 - sig/userplex/models/user_identify_params.rbs
 - sig/userplex/models/user_identify_response.rbs
 - sig/userplex/request_options.rbs
-- sig/userplex/resources/logs.rbs
+- sig/userplex/resources/events.rbs
 - sig/userplex/resources/users.rbs
 - sig/userplex/version.rbs
 homepage: https://gemdocs.org/gems/userplex

data/lib/userplex/resources/logs.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Userplex
-  module Resources
-    class Logs
-      # @api private
-      #
-      # @param client [Userplex::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/userplex/resources/logs.rbi

@@ -1,12 +0,0 @@
-# typed: strong
-
-module Userplex
-  module Resources
-    class Logs
-      # @api private
-      sig { params(client: Userplex::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/sig/userplex/resources/logs.rbs

@@ -1,7 +0,0 @@
-module Userplex
-  module Resources
-    class Logs
-      def initialize: (client: Userplex::Client) -> void
-    end
-  end
-end