userplex 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ff9fa78fe9bab439ced86e294ad900179c8ca864d53b5042ebda75261e45bf
-  data.tar.gz: d715f5b46e3494c94d9c4abcc729eb8e0a2a640a98ad6e34bcfd5dce11e34607
+  metadata.gz: b4474fb917ace6a7ed179789609bd66064fdc3ba4992f9028e68643f0916f5c8
+  data.tar.gz: 6fdb6217c5bd87417eba1e118f9754c5de54623589c375fdf6fd7e61331d01cb
 SHA512:
-  metadata.gz: 451247a5b266118ea1f67826480633c7c549d47151681d840adeebb9d29b177b527a7a91cfceeefa8493b7da996f823cf407d89c77fd38ab91c5cf6cf2d15c2e
-  data.tar.gz: 64f49652f7cb2217d3256da89643ab3419409f01c21c87304ad8a47d286478fb68e64d29ff565e3e262aadeda16f3cfa52205b53660caa08a15c330833f4e3c7
+  metadata.gz: 6b1817878f54c458f555308942cd10a0041c21fcc01e35817587fdb44ad7d45470079eb2de2d1235078c83b812f338db72b3cbbc9d4ab1837666d9e56c814ee9
+  data.tar.gz: 2f622ad91b6030415e19632295c23cfc76f49d7202502e183c59922804eeb90591c81ba76c903d9bc421adc3f436ef2100a66a90fd1ca4f872f9d17962e1ba96

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.13.0 (2026-01-05)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/dqnamo/userplex-ruby/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** api update ([4e1dbe9](https://github.com/dqnamo/userplex-ruby/commit/4e1dbe93fc8479e90240f09d7ceddd850c053efa))
+
+## 0.12.0 (2026-01-05)
+
+Full Changelog: [v0.11.0...v0.12.0](https://github.com/dqnamo/userplex-ruby/compare/v0.11.0...v0.12.0)
+
+### Features
+
+* **api:** api update ([364f01a](https://github.com/dqnamo/userplex-ruby/commit/364f01a66b2d7d990281687b5104b1ce796b692d))
+
 ## 0.11.0 (2026-01-05)
 
 Full Changelog: [v0.10.0...v0.11.0](https://github.com/dqnamo/userplex-ruby/compare/v0.10.0...v0.11.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.11.0"
+gem "userplex", "~> 0.13.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,7 +26,9 @@ gem "userplex", "~> 0.11.0"
 require "bundler/setup"
 require "userplex"
 
-userplex = Userplex::Client.new(api_key: "My API Key")
+userplex = Userplex::Client.new(
+  api_key: ENV["USERPLEX_API_KEY"] # This is the default and can be omitted
+)
 
 response = userplex.logs.new(name: "REPLACE_ME")
 
@@ -78,8 +80,7 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 userplex = Userplex::Client.new(
-  max_retries: 0, # default is 2
-  api_key: "My API Key"
+  max_retries: 0 # default is 2
 )
 
 # Or, configure per-request:
@@ -93,8 +94,7 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 userplex = Userplex::Client.new(
-  timeout: nil, # default is 60
-  api_key: "My API Key"
+  timeout: nil # default is 60
 )
 
 # Or, configure per-request:

data/lib/userplex/client.rb

@@ -25,6 +25,15 @@ module Userplex
     # @return [Userplex::Resources::Logs]
     attr_reader :logs
 
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
     # Creates and returns a new client for interacting with the API.
     #
     # @param api_key [String, nil] Enter your API key from your project settings Defaults to

data/lib/userplex/internal/transport/base_client.rb

@@ -215,6 +215,11 @@ module Userplex
           @max_retry_delay = max_retry_delay
         end
 
+        # @api private
+        #
+        # @return [Hash{String=>String}]
+        private def auth_headers = {}
+
         # @api private
         #
         # @return [String]
@@ -271,6 +276,7 @@ module Userplex
 
           headers = Userplex::Internal::Util.normalized_headers(
             @headers,
+            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

data/lib/userplex/models/log_batch_params.rb

@@ -8,49 +8,40 @@ module Userplex
       include Userplex::Internal::Type::RequestParameters
 
       # @!attribute body
-      #   A list of logs to ingest
       #
       #   @return [Array<Userplex::Models::LogBatchParams::Body>, nil]
       optional :body, -> { Userplex::Internal::Type::ArrayOf[Userplex::LogBatchParams::Body] }
 
       # @!method initialize(body: nil, request_options: {})
-      #   @param body [Array<Userplex::Models::LogBatchParams::Body>] A list of logs to ingest
-      #
+      #   @param body [Array<Userplex::Models::LogBatchParams::Body>]
       #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
 
       class Body < Userplex::Internal::Type::BaseModel
         # @!attribute name
-        #   Log name
         #
         #   @return [String]
         required :name, String
 
         # @!attribute data
-        #   Additional log data
         #
         #   @return [Hash{Symbol=>Object, nil}, nil]
         optional :data, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
 
         # @!attribute timestamp
-        #   Log timestamp (ISO 8601)
         #
         #   @return [Time, nil]
         optional :timestamp, Time
 
         # @!attribute user_id
-        #   External user ID
         #
         #   @return [String, nil]
         optional :user_id, String
 
         # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil)
-        #   @param name [String] Log name
-        #
-        #   @param data [Hash{Symbol=>Object, nil}] Additional log data
-        #
-        #   @param timestamp [Time] Log timestamp (ISO 8601)
-        #
-        #   @param user_id [String] External user ID
+        #   @param name [String]
+        #   @param data [Hash{Symbol=>Object, nil}]
+        #   @param timestamp [Time]
+        #   @param user_id [String]
       end
     end
   end

data/lib/userplex/models/log_new_params.rb

@@ -8,38 +8,30 @@ module Userplex
       include Userplex::Internal::Type::RequestParameters
 
       # @!attribute name
-      #   Log name
       #
       #   @return [String]
       required :name, String
 
       # @!attribute data
-      #   Additional log data
       #
       #   @return [Hash{Symbol=>Object, nil}, nil]
       optional :data, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
 
       # @!attribute timestamp
-      #   Log timestamp (ISO 8601)
       #
       #   @return [Time, nil]
       optional :timestamp, Time
 
       # @!attribute user_id
-      #   External user ID
       #
       #   @return [String, nil]
       optional :user_id, String
 
       # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
-      #   @param name [String] Log name
-      #
-      #   @param data [Hash{Symbol=>Object, nil}] Additional log data
-      #
-      #   @param timestamp [Time] Log timestamp (ISO 8601)
-      #
-      #   @param user_id [String] External user ID
-      #
+      #   @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

data/lib/userplex/models/user_identify_params.rb

@@ -8,38 +8,30 @@ module Userplex
       include Userplex::Internal::Type::RequestParameters
 
       # @!attribute user_id
-      #   External user ID
       #
       #   @return [String]
       required :user_id, String
 
       # @!attribute attributes
-      #   Additional user attributes
       #
       #   @return [Hash{Symbol=>Object, nil}, nil]
       optional :attributes, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
 
       # @!attribute email
-      #   User email
       #
       #   @return [String, nil]
       optional :email, String
 
       # @!attribute name
-      #   User name
       #
       #   @return [String, nil]
       optional :name, String
 
       # @!method initialize(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
-      #   @param user_id [String] External user ID
-      #
-      #   @param attributes [Hash{Symbol=>Object, nil}] Additional user attributes
-      #
-      #   @param email [String] User email
-      #
-      #   @param name [String] User name
-      #
+      #   @param user_id [String]
+      #   @param attributes [Hash{Symbol=>Object, nil}]
+      #   @param email [String]
+      #   @param name [String]
       #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/userplex/resources/logs.rb

@@ -3,10 +3,11 @@
 module Userplex
   module Resources
     class Logs
-      # @overload batch(body: nil, request_options: {})
+      # Log multiple events
       #
-      # @param body [Array<Userplex::Models::LogBatchParams::Body>] A list of logs to ingest
+      # @overload batch(body: nil, request_options: {})
       #
+      # @param body [Array<Userplex::Models::LogBatchParams::Body>]
       # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Userplex::Models::LogBatchResponse]
@@ -23,16 +24,14 @@ module Userplex
         )
       end
 
-      # @overload new(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
-      #
-      # @param name [String] Log name
+      # Log a single event
       #
-      # @param data [Hash{Symbol=>Object, nil}] Additional log data
-      #
-      # @param timestamp [Time] Log timestamp (ISO 8601)
-      #
-      # @param user_id [String] External user ID
+      # @overload new(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::LogNewResponse]

data/lib/userplex/resources/users.rb

@@ -3,16 +3,14 @@
 module Userplex
   module Resources
     class Users
-      # @overload identify(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
-      #
-      # @param user_id [String] External user ID
-      #
-      # @param attributes [Hash{Symbol=>Object, nil}] Additional user attributes
+      # Identify a user
       #
-      # @param email [String] User email
-      #
-      # @param name [String] User name
+      # @overload identify(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
       #
+      # @param user_id [String]
+      # @param attributes [Hash{Symbol=>Object, nil}]
+      # @param email [String]
+      # @param name [String]
       # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Userplex::Models::UserIdentifyResponse]

data/lib/userplex/version.rb

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

data/rbi/userplex/client.rbi

@@ -20,6 +20,11 @@ module Userplex
     sig { returns(Userplex::Resources::Logs) }
     attr_reader :logs
 
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
     # Creates and returns a new client for interacting with the API.
     sig do
       params(

data/rbi/userplex/internal/transport/base_client.rbi

@@ -171,6 +171,11 @@ module Userplex
         )
         end
 
+        # @api private
+        sig { overridable.returns(T::Hash[String, String]) }
+        private def auth_headers
+        end
+
         # @api private
         sig { returns(String) }
         private def user_agent

data/rbi/userplex/models/log_batch_params.rbi

@@ -11,7 +11,6 @@ module Userplex
           T.any(Userplex::LogBatchParams, Userplex::Internal::AnyHash)
         end
 
-      # A list of logs to ingest
       sig { returns(T.nilable(T::Array[Userplex::LogBatchParams::Body])) }
       attr_reader :body
 
@@ -26,11 +25,7 @@ module Userplex
           request_options: Userplex::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # A list of logs to ingest
-        body: nil,
-        request_options: {}
-      )
+      def self.new(body: nil, request_options: {})
       end
 
       sig do
@@ -50,25 +45,21 @@ module Userplex
             T.any(Userplex::LogBatchParams::Body, Userplex::Internal::AnyHash)
           end
 
-        # Log name
         sig { returns(String) }
         attr_accessor :name
 
-        # Additional log data
         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
 
-        # Log timestamp (ISO 8601)
         sig { returns(T.nilable(Time)) }
         attr_reader :timestamp
 
         sig { params(timestamp: Time).void }
         attr_writer :timestamp
 
-        # External user ID
         sig { returns(T.nilable(String)) }
         attr_reader :user_id
 
@@ -83,16 +74,7 @@ module Userplex
             user_id: String
           ).returns(T.attached_class)
         end
-        def self.new(
-          # Log name
-          name:,
-          # Additional log data
-          data: nil,
-          # Log timestamp (ISO 8601)
-          timestamp: nil,
-          # External user ID
-          user_id: nil
-        )
+        def self.new(name:, data: nil, timestamp: nil, user_id: nil)
         end
 
         sig do

data/rbi/userplex/models/log_new_params.rbi

@@ -11,25 +11,21 @@ module Userplex
           T.any(Userplex::LogNewParams, Userplex::Internal::AnyHash)
         end
 
-      # Log name
       sig { returns(String) }
       attr_accessor :name
 
-      # Additional log data
       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
 
-      # Log timestamp (ISO 8601)
       sig { returns(T.nilable(Time)) }
       attr_reader :timestamp
 
       sig { params(timestamp: Time).void }
       attr_writer :timestamp
 
-      # External user ID
       sig { returns(T.nilable(String)) }
       attr_reader :user_id
 
@@ -46,13 +42,9 @@ module Userplex
         ).returns(T.attached_class)
       end
       def self.new(
-        # Log name
         name:,
-        # Additional log data
         data: nil,
-        # Log timestamp (ISO 8601)
         timestamp: nil,
-        # External user ID
         user_id: nil,
         request_options: {}
       )

data/rbi/userplex/models/user_identify_params.rbi

@@ -11,25 +11,21 @@ module Userplex
           T.any(Userplex::UserIdentifyParams, Userplex::Internal::AnyHash)
         end
 
-      # External user ID
       sig { returns(String) }
       attr_accessor :user_id
 
-      # Additional user attributes
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
       attr_reader :attributes
 
       sig { params(attributes: T::Hash[Symbol, T.nilable(T.anything)]).void }
       attr_writer :attributes
 
-      # User email
       sig { returns(T.nilable(String)) }
       attr_reader :email
 
       sig { params(email: String).void }
       attr_writer :email
 
-      # User name
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
@@ -46,13 +42,9 @@ module Userplex
         ).returns(T.attached_class)
       end
       def self.new(
-        # External user ID
         user_id:,
-        # Additional user attributes
         attributes: nil,
-        # User email
         email: nil,
-        # User name
         name: nil,
         request_options: {}
       )

data/rbi/userplex/resources/logs.rbi

@@ -3,19 +3,17 @@
 module Userplex
   module Resources
     class Logs
+      # Log multiple events
       sig do
         params(
           body: T::Array[Userplex::LogBatchParams::Body::OrHash],
           request_options: Userplex::RequestOptions::OrHash
         ).returns(Userplex::Models::LogBatchResponse)
       end
-      def batch(
-        # A list of logs to ingest
-        body: nil,
-        request_options: {}
-      )
+      def batch(body: nil, request_options: {})
       end
 
+      # Log a single event
       sig do
         params(
           name: String,
@@ -26,13 +24,9 @@ module Userplex
         ).returns(Userplex::Models::LogNewResponse)
       end
       def new(
-        # Log name
         name:,
-        # Additional log data
         data: nil,
-        # Log timestamp (ISO 8601)
         timestamp: nil,
-        # External user ID
         user_id: nil,
         request_options: {}
       )

data/rbi/userplex/resources/users.rbi

@@ -3,6 +3,7 @@
 module Userplex
   module Resources
     class Users
+      # Identify a user
       sig do
         params(
           user_id: String,
@@ -13,13 +14,9 @@ module Userplex
         ).returns(Userplex::Models::UserIdentifyResponse)
       end
       def identify(
-        # External user ID
         user_id:,
-        # Additional user attributes
         attributes: nil,
-        # User email
         email: nil,
-        # User name
         name: nil,
         request_options: {}
       )

data/sig/userplex/client.rbs

@@ -14,6 +14,8 @@ module Userplex
 
     attr_reader logs: Userplex::Resources::Logs
 
+    private def auth_headers: -> ::Hash[String, String]
+
     def initialize: (
       ?api_key: String?,
       ?base_url: String?,

data/sig/userplex/internal/transport/base_client.rbs

@@ -85,6 +85,8 @@ module Userplex
           ?idempotency_header: String?
         ) -> void
 
+        private def auth_headers: -> ::Hash[String, String]
+
         private def user_agent: -> String
 
         private def generate_idempotency_key: -> String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: userplex
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Userplex