safetykit 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a671107be88330ee0f811d53e8682de7abeb3af6a2688377967666e24cd914
-  data.tar.gz: f3dacbc2b9ec525bf4227eb490ea5e9b49bd9c1504899b0b1211648ea2e78155
+  metadata.gz: 18d4c898a7bdefdec9b263795c9926227f77232a5f2da50f728f5bd50c308220
+  data.tar.gz: e47f52616b601c40e3402979a2d5f79d3782e5d8aad4027d3521ea9f66399f3c
 SHA512:
-  metadata.gz: 236641839506941d2c51deea450ac238e96b06dab2f3127a8e4c2ef6408cb4c4b8fd5c65c514a256ecfd18151c92d4d5122acd0f75898ca88e0d858f5d06e10b
-  data.tar.gz: 9f0391fc5968b36964e3afff66bc74a39f9abb9889b15f34028ed5a534d52b0cff47f014d0bf499233172796a84cf99721a495c7f07d1fa5329d0e73c6cd25d5
+  metadata.gz: 1d2a4c106c7fe8376a58d466cab735769e94110b3cf4360be8b789820a336e007456e6c5ae444bc07512784b6168980cc964f261c7fcbbcf5de2df38c76ac703
+  data.tar.gz: 8dc9ec8ced457812412944b1504acd16e7232ff530df96eccdb72ec11fbf85faf16b9f8a21629f7f8aa33bc66e2ee4e94fc27bca098a1d4b642dc0b74c87435c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.10.0 (2026-06-01)
+
+Full Changelog: [v0.9.0...v0.10.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.9.0...v0.10.0)
+
+### Features
+
+* **api:** api update ([aee3f63](https://github.com/GetSafetyKit/safetykit-ruby/commit/aee3f6328ed102537734db57da1b09fc90c8b5a7))
+
 ## 0.9.0 (2026-06-01)
 
 Full Changelog: [v0.8.0...v0.9.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.8.0...v0.9.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "safetykit", "~> 0.9.0"
+gem "safetykit", "~> 0.10.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/safety_kit/models/client_session_create_session_params.rb

@@ -7,24 +7,85 @@ module SafetyKit
       extend SafetyKit::Internal::Type::RequestParameters::Converter
       include SafetyKit::Internal::Type::RequestParameters
 
-      # @!attribute customer_session_hash
-      #   Hashed customer browser session value associated with the browser SDK session.
+      # @!attribute body
+      #   Request body for creating a browser-safe webapp SDK session token from
+      #   server-side code. Provide at least one of customer_user_id or
+      #   customer_session_hash.
       #
-      #   @return [String, nil]
-      optional :customer_session_hash, String
+      #   @return [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1, nil]
+      optional :body, union: -> { SafetyKit::ClientSessionCreateSessionParams::Body }
 
-      # @!attribute customer_user_id
-      #   Customer user identifier associated with the browser SDK session.
+      # @!method initialize(body: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::ClientSessionCreateSessionParams} for more details.
       #
-      #   @return [String, nil]
-      optional :customer_user_id, String
-
-      # @!method initialize(customer_session_hash: nil, customer_user_id: nil, request_options: {})
-      #   @param customer_session_hash [String] Hashed customer browser session value associated with the browser SDK session.
-      #
-      #   @param customer_user_id [String] Customer user identifier associated with the browser SDK session.
+      #   @param body [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1] Request body for creating a browser-safe webapp SDK session token from server-si
       #
       #   @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+
+      # Request body for creating a browser-safe webapp SDK session token from
+      # server-side code. Provide at least one of customer_user_id or
+      # customer_session_hash.
+      module Body
+        extend SafetyKit::Internal::Type::Union
+
+        variant -> { SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0 }
+
+        variant -> { SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1 }
+
+        class UnionMember0 < SafetyKit::Internal::Type::BaseModel
+          # @!attribute customer_user_id
+          #   Customer user identifier associated with the browser SDK session. Use the same
+          #   canonical user ID string that you send as user_id in SafetyKit server-to-server
+          #   events.
+          #
+          #   @return [String]
+          required :customer_user_id, String
+
+          # @!attribute customer_session_hash
+          #   Stable opaque customer session hash associated with the browser SDK session.
+          #
+          #   @return [String, nil]
+          optional :customer_session_hash, String
+
+          # @!method initialize(customer_user_id:, customer_session_hash: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0} for
+          #   more details.
+          #
+          #   @param customer_user_id [String] Customer user identifier associated with the browser SDK session. Use the same c
+          #
+          #   @param customer_session_hash [String] Stable opaque customer session hash associated with the browser SDK session.
+        end
+
+        class UnionMember1 < SafetyKit::Internal::Type::BaseModel
+          # @!attribute customer_session_hash
+          #   Stable opaque customer session hash associated with the browser SDK session.
+          #
+          #   @return [String]
+          required :customer_session_hash, String
+
+          # @!attribute customer_user_id
+          #   Customer user identifier associated with the browser SDK session. Use the same
+          #   canonical user ID string that you send as user_id in SafetyKit server-to-server
+          #   events.
+          #
+          #   @return [String, nil]
+          optional :customer_user_id, String
+
+          # @!method initialize(customer_session_hash:, customer_user_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1} for
+          #   more details.
+          #
+          #   @param customer_session_hash [String] Stable opaque customer session hash associated with the browser SDK session.
+          #
+          #   @param customer_user_id [String] Customer user identifier associated with the browser SDK session. Use the same c
+        end
+
+        # @!method self.variants
+        #   @return [Array(SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1)]
+      end
     end
   end
 end

data/lib/safety_kit/resources/client_sessions.rb

@@ -5,15 +5,19 @@ module SafetyKit
     # Create browser-safe webapp SDK session tokens from authenticated server-side
     # code.
     class ClientSessions
-      # Create a browser-safe SafetyKit webapp SDK session token from server-side code
-      # before rendering pages that load the browser SDK. The request must be
-      # authenticated with a valid Bearer token.
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::ClientSessionCreateSessionParams} for more details.
       #
-      # @overload create_session(customer_session_hash: nil, customer_user_id: nil, request_options: {})
+      # Create a browser-safe SafetyKit webapp SDK session token from server-side code
+      # before rendering pages that load the browser SDK. Provide at least one of
+      # customer_user_id or customer_session_hash. When customer_user_id is present, use
+      # the same canonical user ID string that you send as user_id in SafetyKit
+      # server-to-server events. The request must be authenticated with a valid Bearer
+      # token.
       #
-      # @param customer_session_hash [String] Hashed customer browser session value associated with the browser SDK session.
+      # @overload create_session(body: nil, request_options: {})
       #
-      # @param customer_user_id [String] Customer user identifier associated with the browser SDK session.
+      # @param body [SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember0, SafetyKit::Models::ClientSessionCreateSessionParams::Body::UnionMember1] Request body for creating a browser-safe webapp SDK session token from server-si
       #
       # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -26,7 +30,7 @@ module SafetyKit
         @client.request(
           method: :post,
           path: path,
-          body: parsed,
+          body: parsed[:body],
           model: SafetyKit::Models::ClientSessionCreateSessionResponse,
           options: options
         )

data/lib/safety_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafetyKit
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/rbi/safety_kit/models/client_session_create_session_params.rbi

@@ -14,32 +14,47 @@ module SafetyKit
           )
         end
 
-      # Hashed customer browser session value associated with the browser SDK session.
-      sig { returns(T.nilable(String)) }
-      attr_reader :customer_session_hash
-
-      sig { params(customer_session_hash: String).void }
-      attr_writer :customer_session_hash
-
-      # Customer user identifier associated with the browser SDK session.
-      sig { returns(T.nilable(String)) }
-      attr_reader :customer_user_id
+      # Request body for creating a browser-safe webapp SDK session token from
+      # server-side code. Provide at least one of customer_user_id or
+      # customer_session_hash.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0,
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1
+            )
+          )
+        )
+      end
+      attr_reader :body
 
-      sig { params(customer_user_id: String).void }
-      attr_writer :customer_user_id
+      sig do
+        params(
+          body:
+            T.any(
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0::OrHash,
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1::OrHash
+            )
+        ).void
+      end
+      attr_writer :body
 
       sig do
         params(
-          customer_session_hash: String,
-          customer_user_id: String,
+          body:
+            T.any(
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0::OrHash,
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1::OrHash
+            ),
           request_options: SafetyKit::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Hashed customer browser session value associated with the browser SDK session.
-        customer_session_hash: nil,
-        # Customer user identifier associated with the browser SDK session.
-        customer_user_id: nil,
+        # Request body for creating a browser-safe webapp SDK session token from
+        # server-side code. Provide at least one of customer_user_id or
+        # customer_session_hash.
+        body: nil,
         request_options: {}
       )
       end
@@ -47,14 +62,136 @@ module SafetyKit
       sig do
         override.returns(
           {
-            customer_session_hash: String,
-            customer_user_id: String,
+            body:
+              T.any(
+                SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0,
+                SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1
+              ),
             request_options: SafetyKit::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Request body for creating a browser-safe webapp SDK session token from
+      # server-side code. Provide at least one of customer_user_id or
+      # customer_session_hash.
+      module Body
+        extend SafetyKit::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0,
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1
+            )
+          end
+
+        class UnionMember0 < SafetyKit::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0,
+                SafetyKit::Internal::AnyHash
+              )
+            end
+
+          # Customer user identifier associated with the browser SDK session. Use the same
+          # canonical user ID string that you send as user_id in SafetyKit server-to-server
+          # events.
+          sig { returns(String) }
+          attr_accessor :customer_user_id
+
+          # Stable opaque customer session hash associated with the browser SDK session.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_session_hash
+
+          sig { params(customer_session_hash: String).void }
+          attr_writer :customer_session_hash
+
+          sig do
+            params(
+              customer_user_id: String,
+              customer_session_hash: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Customer user identifier associated with the browser SDK session. Use the same
+            # canonical user ID string that you send as user_id in SafetyKit server-to-server
+            # events.
+            customer_user_id:,
+            # Stable opaque customer session hash associated with the browser SDK session.
+            customer_session_hash: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { customer_user_id: String, customer_session_hash: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class UnionMember1 < SafetyKit::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1,
+                SafetyKit::Internal::AnyHash
+              )
+            end
+
+          # Stable opaque customer session hash associated with the browser SDK session.
+          sig { returns(String) }
+          attr_accessor :customer_session_hash
+
+          # Customer user identifier associated with the browser SDK session. Use the same
+          # canonical user ID string that you send as user_id in SafetyKit server-to-server
+          # events.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_user_id
+
+          sig { params(customer_user_id: String).void }
+          attr_writer :customer_user_id
+
+          sig do
+            params(
+              customer_session_hash: String,
+              customer_user_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Stable opaque customer session hash associated with the browser SDK session.
+            customer_session_hash:,
+            # Customer user identifier associated with the browser SDK session. Use the same
+            # canonical user ID string that you send as user_id in SafetyKit server-to-server
+            # events.
+            customer_user_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { customer_session_hash: String, customer_user_id: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[
+              SafetyKit::ClientSessionCreateSessionParams::Body::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
     end
   end
 end

data/rbi/safety_kit/resources/client_sessions.rbi

@@ -6,20 +6,26 @@ module SafetyKit
     # code.
     class ClientSessions
       # Create a browser-safe SafetyKit webapp SDK session token from server-side code
-      # before rendering pages that load the browser SDK. The request must be
-      # authenticated with a valid Bearer token.
+      # before rendering pages that load the browser SDK. Provide at least one of
+      # customer_user_id or customer_session_hash. When customer_user_id is present, use
+      # the same canonical user ID string that you send as user_id in SafetyKit
+      # server-to-server events. The request must be authenticated with a valid Bearer
+      # token.
       sig do
         params(
-          customer_session_hash: String,
-          customer_user_id: String,
+          body:
+            T.any(
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0::OrHash,
+              SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1::OrHash
+            ),
           request_options: SafetyKit::RequestOptions::OrHash
         ).returns(SafetyKit::Models::ClientSessionCreateSessionResponse)
       end
       def create_session(
-        # Hashed customer browser session value associated with the browser SDK session.
-        customer_session_hash: nil,
-        # Customer user identifier associated with the browser SDK session.
-        customer_user_id: nil,
+        # Request body for creating a browser-safe webapp SDK session token from
+        # server-side code. Provide at least one of customer_user_id or
+        # customer_session_hash.
+        body: nil,
         request_options: {}
       )
       end

data/sig/safety_kit/models/client_session_create_session_params.rbs

@@ -1,32 +1,80 @@
 module SafetyKit
   module Models
     type client_session_create_session_params =
-      { customer_session_hash: String, customer_user_id: String }
+      { body: SafetyKit::Models::ClientSessionCreateSessionParams::body }
       & SafetyKit::Internal::Type::request_parameters
 
     class ClientSessionCreateSessionParams < SafetyKit::Internal::Type::BaseModel
       extend SafetyKit::Internal::Type::RequestParameters::Converter
       include SafetyKit::Internal::Type::RequestParameters
 
-      attr_reader customer_session_hash: String?
+      attr_reader body: SafetyKit::Models::ClientSessionCreateSessionParams::body?
 
-      def customer_session_hash=: (String) -> String
-
-      attr_reader customer_user_id: String?
-
-      def customer_user_id=: (String) -> String
+      def body=: (
+        SafetyKit::Models::ClientSessionCreateSessionParams::body
+      ) -> SafetyKit::Models::ClientSessionCreateSessionParams::body
 
       def initialize: (
-        ?customer_session_hash: String,
-        ?customer_user_id: String,
+        ?body: SafetyKit::Models::ClientSessionCreateSessionParams::body,
         ?request_options: SafetyKit::request_opts
       ) -> void
 
       def to_hash: -> {
-        customer_session_hash: String,
-        customer_user_id: String,
+        body: SafetyKit::Models::ClientSessionCreateSessionParams::body,
         request_options: SafetyKit::RequestOptions
       }
+
+      type body =
+        SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember0
+        | SafetyKit::ClientSessionCreateSessionParams::Body::UnionMember1
+
+      module Body
+        extend SafetyKit::Internal::Type::Union
+
+        type union_member0 =
+          { customer_user_id: String, customer_session_hash: String }
+
+        class UnionMember0 < SafetyKit::Internal::Type::BaseModel
+          attr_accessor customer_user_id: String
+
+          attr_reader customer_session_hash: String?
+
+          def customer_session_hash=: (String) -> String
+
+          def initialize: (
+            customer_user_id: String,
+            ?customer_session_hash: String
+          ) -> void
+
+          def to_hash: -> {
+            customer_user_id: String,
+            customer_session_hash: String
+          }
+        end
+
+        type union_member1 =
+          { customer_session_hash: String, customer_user_id: String }
+
+        class UnionMember1 < SafetyKit::Internal::Type::BaseModel
+          attr_accessor customer_session_hash: String
+
+          attr_reader customer_user_id: String?
+
+          def customer_user_id=: (String) -> String
+
+          def initialize: (
+            customer_session_hash: String,
+            ?customer_user_id: String
+          ) -> void
+
+          def to_hash: -> {
+            customer_session_hash: String,
+            customer_user_id: String
+          }
+        end
+
+        def self?.variants: -> ::Array[SafetyKit::Models::ClientSessionCreateSessionParams::body]
+      end
     end
   end
 end

data/sig/safety_kit/resources/client_sessions.rbs

@@ -2,8 +2,7 @@ module SafetyKit
   module Resources
     class ClientSessions
       def create_session: (
-        ?customer_session_hash: String,
-        ?customer_user_id: String,
+        ?body: SafetyKit::Models::ClientSessionCreateSessionParams::body,
         ?request_options: SafetyKit::request_opts
       ) -> SafetyKit::Models::ClientSessionCreateSessionResponse
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safetykit
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Safetykit