userplex 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765c1873eeacaf34a97e425f74774ec55ecc2e359ea5796f7425099cc06f5bb3
-  data.tar.gz: 4185d106d6180c41fcfa61e6317e2e9a06392147d8271f399ccb0da0a4c2d36e
+  metadata.gz: 7ee0aca7256c78b7a28f7c4412e04b9e6b85b348c8f3a8daf339542a1af438e0
+  data.tar.gz: 0be918b8e525d4a469f7a63a9e65d25b099a4c9e2bdfaeba0cb6d1ab655d6d24
 SHA512:
-  metadata.gz: a8c74f8721c5033df8737f30a147d86b02801c39fcb1e0ede11ddd5622a246ef0a4f93e848a0557089ea956acfd6badc7d67fec7ece83e639099f598fd6c6567
-  data.tar.gz: 6c350002c4da00c768fc4f3bcc21e18268a47f70cc7a707a8a6ad7281f57d5c0d6c1875aa87ed31e16ec3419d46068cf13991a578e1a2303b03a905518d4e497
+  metadata.gz: c57bb3276dd125585396354370449d33cd4b9197823e8a2ff767fc44d22ce077385e413dbc13f404f9045fb29fe2da8b6113426e7de504f2528e71c55604dd3d
+  data.tar.gz: 5e8bf1a3a79a56f6cc4cf93d15e401857d2a5a889f4b8a6b7a405848cfe4fd92ef1ccfde685eef6934817ebbf094e8f68943111fc6253bd9de8ba9b027225729

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0 (2025-12-13)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/dqnamo/userplex-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** api update ([b33db1c](https://github.com/dqnamo/userplex-ruby/commit/b33db1c4c76aa53c7970c48a7d151fb7195cf764))
+
 ## 0.4.0 (2025-12-13)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/dqnamo/userplex-ruby/compare/v0.3.0...v0.4.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.4.0"
+gem "userplex", "~> 0.5.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(email: "REPLACE_ME", name: "REPLACE_ME", user_id: "REPLACE_ME")
+response = userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
 
 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(email: "REPLACE_ME", name: "REPLACE_ME", user_id: "REPLACE_ME")
+  user = userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
 rescue Userplex::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -85,9 +85,9 @@ userplex = Userplex::Client.new(
 
 # Or, configure per-request:
 userplex.users.identify(
+  user_id: "user_id",
   email: "REPLACE_ME",
   name: "REPLACE_ME",
-  user_id: "REPLACE_ME",
   request_options: {max_retries: 5}
 )
 ```
@@ -104,9 +104,9 @@ userplex = Userplex::Client.new(
 
 # Or, configure per-request:
 userplex.users.identify(
+  user_id: "user_id",
   email: "REPLACE_ME",
   name: "REPLACE_ME",
-  user_id: "REPLACE_ME",
   request_options: {timeout: 5}
 )
 ```
@@ -140,9 +140,9 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 ```ruby
 response =
   userplex.users.identify(
+    user_id: "user_id",
     email: "REPLACE_ME",
     name: "REPLACE_ME",
-    user_id: "REPLACE_ME",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -188,17 +188,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-userplex.users.identify(email: "REPLACE_ME", name: "REPLACE_ME", user_id: "REPLACE_ME")
+userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-userplex.users.identify(email: "REPLACE_ME", name: "REPLACE_ME", user_id: "REPLACE_ME")
+userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
 
 # You can also splat a full Params class:
-params = Userplex::UserIdentifyParams.new(email: "REPLACE_ME", name: "REPLACE_ME", user_id: "REPLACE_ME")
+params = Userplex::UserIdentifyParams.new(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
 userplex.users.identify(**params)
 ```
 

data/lib/userplex/models/user_identify_params.rb

@@ -7,23 +7,23 @@ module Userplex
       extend Userplex::Internal::Type::RequestParameters::Converter
       include Userplex::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #   Unique identifier for the user
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute email
       #   User email address
       #
-      #   @return [String]
-      required :email, String
+      #   @return [String, nil]
+      optional :email, String
 
       # @!attribute name
       #   User full name
       #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute user_id
-      #   Unique identifier for the user
-      #
-      #   @return [String]
-      required :user_id, String, api_name: :userId
+      #   @return [String, nil]
+      optional :name, String
 
       # @!attribute properties
       #   Additional user properties
@@ -31,13 +31,13 @@ module Userplex
       #   @return [Hash{Symbol=>Object, nil}, nil]
       optional :properties, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
 
-      # @!method initialize(email:, name:, user_id:, properties: nil, request_options: {})
+      # @!method initialize(user_id:, email: nil, name: nil, properties: nil, request_options: {})
+      #   @param user_id [String] Unique identifier for the user
+      #
       #   @param email [String] User email address
       #
       #   @param name [String] User full name
       #
-      #   @param user_id [String] Unique identifier for the user
-      #
       #   @param properties [Hash{Symbol=>Object, nil}] Additional user properties
       #
       #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]

data/lib/userplex/resources/users.rb

@@ -6,14 +6,14 @@ module Userplex
       # Creates or updates an end user in InstantDB with the provided information.
       # Requires a valid API key for authentication.
       #
-      # @overload identify(email:, name:, user_id:, properties: nil, request_options: {})
+      # @overload identify(user_id:, email: nil, name: nil, properties: nil, request_options: {})
+      #
+      # @param user_id [String] Unique identifier for the user
       #
       # @param email [String] User email address
       #
       # @param name [String] User full name
       #
-      # @param user_id [String] Unique identifier for the user
-      #
       # @param properties [Hash{Symbol=>Object, nil}] Additional user properties
       #
       # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/userplex/version.rb

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

data/rbi/userplex/models/user_identify_params.rbi

@@ -11,17 +11,23 @@ module Userplex
           T.any(Userplex::UserIdentifyParams, Userplex::Internal::AnyHash)
         end
 
-      # User email address
+      # Unique identifier for the user
       sig { returns(String) }
-      attr_accessor :email
+      attr_accessor :user_id
+
+      # User email address
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
 
       # User full name
-      sig { returns(String) }
-      attr_accessor :name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
 
-      # Unique identifier for the user
-      sig { returns(String) }
-      attr_accessor :user_id
+      sig { params(name: String).void }
+      attr_writer :name
 
       # Additional user properties
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
@@ -32,20 +38,20 @@ module Userplex
 
       sig do
         params(
+          user_id: String,
           email: String,
           name: String,
-          user_id: String,
           properties: T::Hash[Symbol, T.nilable(T.anything)],
           request_options: Userplex::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # User email address
-        email:,
-        # User full name
-        name:,
         # Unique identifier for the user
         user_id:,
+        # User email address
+        email: nil,
+        # User full name
+        name: nil,
         # Additional user properties
         properties: nil,
         request_options: {}
@@ -55,9 +61,9 @@ module Userplex
       sig do
         override.returns(
           {
+            user_id: String,
             email: String,
             name: String,
-            user_id: String,
             properties: T::Hash[Symbol, T.nilable(T.anything)],
             request_options: Userplex::RequestOptions
           }

data/rbi/userplex/resources/users.rbi

@@ -7,20 +7,20 @@ module Userplex
       # Requires a valid API key for authentication.
       sig do
         params(
+          user_id: String,
           email: String,
           name: String,
-          user_id: String,
           properties: T::Hash[Symbol, T.nilable(T.anything)],
           request_options: Userplex::RequestOptions::OrHash
         ).returns(Userplex::Models::UserIdentifyResponse)
       end
       def identify(
-        # User email address
-        email:,
-        # User full name
-        name:,
         # Unique identifier for the user
         user_id:,
+        # User email address
+        email: nil,
+        # User full name
+        name: nil,
         # Additional user properties
         properties: nil,
         request_options: {}

data/sig/userplex/models/user_identify_params.rbs

@@ -2,9 +2,9 @@ module Userplex
   module Models
     type user_identify_params =
       {
+        user_id: String,
         email: String,
         name: String,
-        user_id: String,
         properties: ::Hash[Symbol, top?]
       }
       & Userplex::Internal::Type::request_parameters
@@ -13,28 +13,32 @@ module Userplex
       extend Userplex::Internal::Type::RequestParameters::Converter
       include Userplex::Internal::Type::RequestParameters
 
-      attr_accessor email: String
+      attr_accessor user_id: String
 
-      attr_accessor name: String
+      attr_reader email: String?
 
-      attr_accessor user_id: String
+      def email=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
 
       attr_reader properties: ::Hash[Symbol, top?]?
 
       def properties=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?]
 
       def initialize: (
-        email: String,
-        name: String,
         user_id: String,
+        ?email: String,
+        ?name: String,
         ?properties: ::Hash[Symbol, top?],
         ?request_options: Userplex::request_opts
       ) -> void
 
       def to_hash: -> {
+        user_id: String,
         email: String,
         name: String,
-        user_id: String,
         properties: ::Hash[Symbol, top?],
         request_options: Userplex::RequestOptions
       }

data/sig/userplex/resources/users.rbs

@@ -2,9 +2,9 @@ module Userplex
   module Resources
     class Users
       def identify: (
-        email: String,
-        name: String,
         user_id: String,
+        ?email: String,
+        ?name: String,
         ?properties: ::Hash[Symbol, top?],
         ?request_options: Userplex::request_opts
       ) -> Userplex::Models::UserIdentifyResponse

metadata

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