knockapi 1.10.2 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf2e78c4a3a157b67ee21c310416f1832ae93d7d3dca66ca5182a4073f718783
-  data.tar.gz: d27105eb023f08041b9323215af94b5253682a6e6aaa9fb7bc80709d70eb4efb
+  metadata.gz: fb73648101e7d2bd451a7d998eb5ded40adcd662a9ca06e29ec4f2f1b4c479dc
+  data.tar.gz: 47715ed958cb260beff0d347ea7e8783a05181e1d34c4394656ba6ac50c3d33a
 SHA512:
-  metadata.gz: 1283a238f41312d15ace45d032f1a66b0a51469d5af2e18370723133b532ae64ff837e9e24fab55e72e7f043c2aad8ee747dab6c0e8cf895d2d8155a83924266
-  data.tar.gz: 25636a8cbf6be36f1f89f80f5735311555cefa8336a81e27d5e75a40489e7c05d30eba79ea135d06fb8dd5066b2bb8e1e61a9a0965b074553905fd04a41c8926
+  metadata.gz: 94968e7c435833897b9d5c574f1f2f81556c937661eeaf1f6854802379fddc9bf4e4f70ebb3096fdc84656361b29e70540956ae6c30d355fdd533102c777f559
+  data.tar.gz: 708aaf055317502fea383da4f0e3350ac35bd08eb07734beffabf71439d46666c67b334eaa5d83afc75f79c83bae241aa949b8d8e8f086257406828f4e352cfa

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 1.11.0 (2025-08-15)
+
+Full Changelog: [v1.10.3...v1.11.0](https://github.com/knocklabs/knock-ruby/compare/v1.10.3...v1.11.0)
+
+### Features
+
+* **api:** api update ([d0ce3fe](https://github.com/knocklabs/knock-ruby/commit/d0ce3fe4004f9f5b663d88f6eea02c1def7a26fa))
+
+## 1.10.3 (2025-08-12)
+
+Full Changelog: [v1.10.2...v1.10.3](https://github.com/knocklabs/knock-ruby/compare/v1.10.2...v1.10.3)
+
+### Bug Fixes
+
+* **internal:** ensure sorbet test always runs serially ([66f6791](https://github.com/knocklabs/knock-ruby/commit/66f67914b8f2c811e98c1a7806fd361463614271))
+
+
+### Chores
+
+* collect metadata from type DSL ([7221a47](https://github.com/knocklabs/knock-ruby/commit/7221a470e5604d56b1e1a91b3504f3400a8e62d2))
+* **internal:** codegen related update ([83d9236](https://github.com/knocklabs/knock-ruby/commit/83d9236dedfc1d4dae46e0b1abed22206461df80))
+* **internal:** increase visibility of internal helper method ([18a3bc1](https://github.com/knocklabs/knock-ruby/commit/18a3bc1e07170a0c0e2595ac17c8a0e74a4855ff))
+* **internal:** update comment in script ([c0a5fc6](https://github.com/knocklabs/knock-ruby/commit/c0a5fc6a4760bb057e222e490700e702f54480fe))
+* update @stainless-api/prism-cli to v5.15.0 ([f92c3e6](https://github.com/knocklabs/knock-ruby/commit/f92c3e6157c76770e840c6c8363bd57565e3e465))
+* update contribute.md ([3ff1a87](https://github.com/knocklabs/knock-ruby/commit/3ff1a87c6bb8111da0f6127d38cc19c2fa5d54fa))
+
 ## 1.10.2 (2025-07-21)
 
 Full Changelog: [v1.10.1...v1.10.2](https://github.com/knocklabs/knock-ruby/compare/v1.10.1...v1.10.2)

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 "knockapi", "~> 1.10.2"
+gem "knockapi", "~> 1.11.0"
 ```
 
 <!-- x-release-please-end -->
@@ -225,25 +225,25 @@ knock.workflows.trigger("dinosaurs-loose", **params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :exclude
-puts(Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE)
+# :merge
+puts(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE)
 
-# Revealed type: `T.all(Knockapi::Users::FeedListItemsParams::Archived, Symbol)`
-T.reveal_type(Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE)
+# Revealed type: `T.all(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy, Symbol)`
+T.reveal_type(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-knock.users.feeds.list_items(
-  archived: Knockapi::Users::FeedListItemsParams::Archived::EXCLUDE,
+knock.users.set_preferences(
+  _persistence_strategy: Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE,
   # …
 )
 
 # Literal values are also permissible:
-knock.users.feeds.list_items(
-  archived: :exclude,
+knock.users.set_preferences(
+  _persistence_strategy: :merge,
   # …
 )
 ```

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

@@ -365,7 +365,7 @@ module Knockapi
         #
         # @raise [Knockapi::Errors::APIError]
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+        def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: Knockapi::Internal::Util.monotonic_secs + timeout}
 

data/lib/knockapi/internal/type/array_of.rb

@@ -148,6 +148,7 @@ module Knockapi
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Knockapi::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = Knockapi::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

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

@@ -52,6 +52,7 @@ module Knockapi
           #
           #   @option spec [Boolean] :"nil?"
           private def add_field(name_sym, required:, type_info:, spec:)
+            meta = Knockapi::Internal::Type::Converter.meta_info(type_info, spec)
             type_fn, info =
               case type_info
               in Proc | Knockapi::Internal::Type::Converter | Class
@@ -81,7 +82,8 @@ module Knockapi
                 required: required,
                 nilable: nilable,
                 const: const,
-                type_fn: type_fn
+                type_fn: type_fn,
+                meta: meta
               }
 
             define_method(setter) do |value|

data/lib/knockapi/internal/type/converter.rb

@@ -98,6 +98,33 @@ module Knockapi
             end
           end
 
+          # @api private
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, Knockapi::Internal::Type::Converter, Class] .
+          #
+          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option type_info [Proc] :enum
+          #
+          #   @option type_info [Proc] :union
+          #
+          #   @option type_info [Boolean] :"nil?"
+          #
+          # @param spec [Hash{Symbol=>Object}, Proc, Knockapi::Internal::Type::Converter, Class] .
+          #
+          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option spec [Proc] :enum
+          #
+          #   @option spec [Proc] :union
+          #
+          #   @option spec [Boolean] :"nil?"
+          #
+          # @return [Hash{Symbol=>Object}]
+          def meta_info(type_info, spec)
+            [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
+          end
+
           # @api private
           #
           # @param translate_names [Boolean]

data/lib/knockapi/internal/type/hash_of.rb

@@ -168,6 +168,7 @@ module Knockapi
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Knockapi::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = Knockapi::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

data/lib/knockapi/internal/type/union.rb

@@ -23,20 +23,20 @@ module Knockapi
         #
         # All of the specified variant info for this union.
         #
-        # @return [Array<Array(Symbol, Proc)>]
+        # @return [Array<Array(Symbol, Proc, Hash{Symbol=>Object})>]
         private def known_variants = (@known_variants ||= [])
 
         # @api private
         #
-        # @return [Array<Array(Symbol, Object)>]
+        # @return [Array<Array(Symbol, Object, Hash{Symbol=>Object})>]
         protected def derefed_variants
-          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] }
         end
 
         # All of the specified variants for this union.
         #
         # @return [Array<Object>]
-        def variants = derefed_variants.map(&:last)
+        def variants = derefed_variants.map { _2 }
 
         # @api private
         #
@@ -62,12 +62,13 @@ module Knockapi
         #
         #   @option spec [Boolean] :"nil?"
         private def variant(key, spec = nil)
+          meta = Knockapi::Internal::Type::Converter.meta_info(nil, spec)
           variant_info =
             case key
             in Symbol
-              [key, Knockapi::Internal::Type::Converter.type_info(spec)]
+              [key, Knockapi::Internal::Type::Converter.type_info(spec), meta]
             in Proc | Knockapi::Internal::Type::Converter | Class | Hash
-              [nil, Knockapi::Internal::Type::Converter.type_info(key)]
+              [nil, Knockapi::Internal::Type::Converter.type_info(key), meta]
             end
 
           known_variants << variant_info
@@ -90,7 +91,8 @@ module Knockapi
             return nil if key == Knockapi::Internal::OMIT
 
             key = key.to_sym if key.is_a?(String)
-            known_variants.find { |k,| k == key }&.last&.call
+            _, found = known_variants.find { |k,| k == key }
+            found&.call
           else
             nil
           end

data/lib/knockapi/models/recipients/preference_set_request.rb

@@ -4,6 +4,15 @@ module Knockapi
   module Models
     module Recipients
       class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
+        # @!attribute _persistence_strategy
+        #   Controls how the preference set is persisted. 'replace' will completely replace
+        #   the preference set, 'merge' will merge with existing preferences.
+        #
+        #   @return [Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::PersistenceStrategy, nil]
+        optional :_persistence_strategy,
+                 enum: -> { Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy },
+                 api_name: :__persistence_strategy__
+
         # @!attribute categories
         #   An object where the key is the category and the values are the preference
         #   settings for that category.
@@ -32,18 +41,34 @@ module Knockapi
                  },
                  nil?: true
 
-        # @!method initialize(categories: nil, channel_types: nil, workflows: nil)
+        # @!method initialize(_persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil)
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Recipients::PreferenceSetRequest} for more details.
         #
         #   A request to set a preference set for a recipient.
         #
+        #   @param _persistence_strategy [Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::PersistenceStrategy] Controls how the preference set is persisted. 'replace' will completely replace
+        #
         #   @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
         #
         #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
         #
         #   @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
 
+        # Controls how the preference set is persisted. 'replace' will completely replace
+        # the preference set, 'merge' will merge with existing preferences.
+        #
+        # @see Knockapi::Models::Recipients::PreferenceSetRequest#_persistence_strategy
+        module PersistenceStrategy
+          extend Knockapi::Internal::Type::Enum
+
+          MERGE = :merge
+          REPLACE = :replace
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # Workflow or category preferences within a preference set
         module Category
           extend Knockapi::Internal::Type::Union

data/lib/knockapi/resources/objects.rb

@@ -425,14 +425,16 @@ module Knockapi
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::ObjectSetPreferencesParams} for more details.
       #
-      # Sets preferences within the given preference set. This is a destructive
-      # operation and will replace any existing preferences with the preferences given.
-      # If no object exists in the current environment for the given `:collection` and
-      # `:object_id`, Knock will create the object as part of this request. The
-      # preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+      # Sets preferences within the given preference set. By default, this is a
+      # destructive operation and will replace any existing preferences with the
+      # preferences given. Use '\_\_persistence_strategy': 'merge' to merge with
+      # existing preferences instead. If no object exists in the current environment for
+      # the given `:collection` and `:object_id`, Knock will create the object as part
+      # of this request. The preference set `:id` can be either `default` or a
+      # `tenant.id`. Learn more about
       # [per-tenant preferences](/preferences/tenant-preferences).
       #
-      # @overload set_preferences(collection, object_id_, id, categories: nil, channel_types: nil, workflows: nil, request_options: {})
+      # @overload set_preferences(collection, object_id_, id, _persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil, request_options: {})
       #
       # @param collection [String] The collection this object belongs to.
       #
@@ -440,6 +442,8 @@ module Knockapi
       #
       # @param id [String] Unique identifier for the preference set.
       #
+      # @param _persistence_strategy [Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::PersistenceStrategy] Controls how the preference set is persisted. 'replace' will completely replace
+      #
       # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
       #
       # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.

data/lib/knockapi/resources/users.rb

@@ -375,15 +375,19 @@ module Knockapi
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::UserSetPreferencesParams} for more details.
       #
-      # Updates a complete preference set for a user. This is a destructive operation
-      # that will replace the existing preference set for the user.
+      # Updates a complete preference set for a user. By default, this is a destructive
+      # operation and will replace any existing preferences with the preferences given.
+      # Use '**persistence_strategy**': 'merge' to merge with existing preferences
+      # instead.
       #
-      # @overload set_preferences(user_id, id, categories: nil, channel_types: nil, workflows: nil, request_options: {})
+      # @overload set_preferences(user_id, id, _persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil, request_options: {})
       #
       # @param user_id [String] The unique identifier of the user.
       #
       # @param id [String] Unique identifier for the preference set.
       #
+      # @param _persistence_strategy [Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::PersistenceStrategy] Controls how the preference set is persisted. 'replace' will completely replace
+      #
       # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
       #
       # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.10.2"
+  VERSION = "1.11.0"
 end

data/rbi/knockapi/internal/transport/base_client.rbi

@@ -213,7 +213,7 @@ module Knockapi
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/knockapi/internal/type/converter.rbi

@@ -90,6 +90,60 @@ module Knockapi
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(
+              type_info:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                  Knockapi::Internal::Type::Converter::Input
+                ),
+              spec:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                  Knockapi::Internal::Type::Converter::Input
+                )
+            ).returns(Knockapi::Internal::AnyHash)
+          end
+          def self.meta_info(type_info, spec)
+          end
+
           # @api private
           sig do
             params(translate_names: T::Boolean).returns(

data/rbi/knockapi/internal/type/union.rbi

@@ -16,7 +16,8 @@ module Knockapi
             T::Array[
               [
                 T.nilable(Symbol),
-                T.proc.returns(Knockapi::Internal::Type::Converter::Input)
+                T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                Knockapi::Internal::AnyHash
               ]
             ]
           )
@@ -25,7 +26,13 @@ module Knockapi
         end
 
         # @api private
-        sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+        sig do
+          returns(
+            T::Array[
+              [T.nilable(Symbol), T.anything, Knockapi::Internal::AnyHash]
+            ]
+          )
+        end
         protected def derefed_variants
         end
 

data/rbi/knockapi/models/recipients/preference_set_request.rbi

@@ -12,6 +12,25 @@ module Knockapi
             )
           end
 
+        # Controls how the preference set is persisted. 'replace' will completely replace
+        # the preference set, 'merge' will merge with existing preferences.
+        sig do
+          returns(
+            T.nilable(
+              Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol
+            )
+          )
+        end
+        attr_reader :_persistence_strategy
+
+        sig do
+          params(
+            _persistence_strategy:
+              Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol
+          ).void
+        end
+        attr_writer :_persistence_strategy
+
         # An object where the key is the category and the values are the preference
         # settings for that category.
         sig do
@@ -63,6 +82,8 @@ module Knockapi
         # A request to set a preference set for a recipient.
         sig do
           params(
+            _persistence_strategy:
+              Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol,
             categories:
               T.nilable(
                 T::Hash[
@@ -90,6 +111,9 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
+          # Controls how the preference set is persisted. 'replace' will completely replace
+          # the preference set, 'merge' will merge with existing preferences.
+          _persistence_strategy: nil,
           # An object where the key is the category and the values are the preference
           # settings for that category.
           categories: nil,
@@ -104,6 +128,8 @@ module Knockapi
         sig do
           override.returns(
             {
+              _persistence_strategy:
+                Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol,
               categories:
                 T.nilable(
                   T::Hash[
@@ -132,6 +158,42 @@ module Knockapi
         def to_hash
         end
 
+        # Controls how the preference set is persisted. 'replace' will completely replace
+        # the preference set, 'merge' will merge with existing preferences.
+        module PersistenceStrategy
+          extend Knockapi::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MERGE =
+            T.let(
+              :merge,
+              Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::TaggedSymbol
+            )
+          REPLACE =
+            T.let(
+              :replace,
+              Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Workflow or category preferences within a preference set
         module Category
           extend Knockapi::Internal::Type::Union

data/rbi/knockapi/resources/objects.rbi

@@ -422,17 +422,21 @@ module Knockapi
       )
       end
 
-      # Sets preferences within the given preference set. This is a destructive
-      # operation and will replace any existing preferences with the preferences given.
-      # If no object exists in the current environment for the given `:collection` and
-      # `:object_id`, Knock will create the object as part of this request. The
-      # preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+      # Sets preferences within the given preference set. By default, this is a
+      # destructive operation and will replace any existing preferences with the
+      # preferences given. Use '\_\_persistence_strategy': 'merge' to merge with
+      # existing preferences instead. If no object exists in the current environment for
+      # the given `:collection` and `:object_id`, Knock will create the object as part
+      # of this request. The preference set `:id` can be either `default` or a
+      # `tenant.id`. Learn more about
       # [per-tenant preferences](/preferences/tenant-preferences).
       sig do
         params(
           collection: String,
           object_id_: String,
           id: String,
+          _persistence_strategy:
+            Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol,
           categories:
             T.nilable(
               T::Hash[
@@ -465,6 +469,9 @@ module Knockapi
         object_id_,
         # Unique identifier for the preference set.
         id,
+        # Controls how the preference set is persisted. 'replace' will completely replace
+        # the preference set, 'merge' will merge with existing preferences.
+        _persistence_strategy: nil,
         # An object where the key is the category and the values are the preference
         # settings for that category.
         categories: nil,

data/rbi/knockapi/resources/users.rbi

@@ -362,12 +362,16 @@ module Knockapi
       )
       end
 
-      # Updates a complete preference set for a user. This is a destructive operation
-      # that will replace the existing preference set for the user.
+      # Updates a complete preference set for a user. By default, this is a destructive
+      # operation and will replace any existing preferences with the preferences given.
+      # Use '**persistence_strategy**': 'merge' to merge with existing preferences
+      # instead.
       sig do
         params(
           user_id: String,
           id: String,
+          _persistence_strategy:
+            Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::OrSymbol,
           categories:
             T.nilable(
               T::Hash[
@@ -398,6 +402,9 @@ module Knockapi
         user_id,
         # Unique identifier for the preference set.
         id,
+        # Controls how the preference set is persisted. 'replace' will completely replace
+        # the preference set, 'merge' will merge with existing preferences.
+        _persistence_strategy: nil,
         # An object where the key is the category and the values are the preference
         # settings for that category.
         categories: nil,

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

@@ -99,7 +99,7 @@ module Knockapi
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           Knockapi::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/knockapi/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module Knockapi
           | Knockapi::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Knockapi::Internal::Type::Converter::input?,
+            union: ^-> Knockapi::Internal::Type::Converter::input?
+          }
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Knockapi::Internal::Type::Converter::input?,
+            union: ^-> Knockapi::Internal::Type::Converter::input?
+          }
+          | ^-> Knockapi::Internal::Type::Converter::input
+          | Knockapi::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> Knockapi::Internal::Type::Converter::coerce_state

data/sig/knockapi/internal/type/union.rbs

@@ -5,9 +5,9 @@ module Knockapi
         include Knockapi::Internal::Type::Converter
         include Knockapi::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> Knockapi::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> Knockapi::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]
 

data/sig/knockapi/models/recipients/preference_set_request.rbs

@@ -3,12 +3,19 @@ module Knockapi
     module Recipients
       type preference_set_request =
         {
+          _persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
           categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
           channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
           workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
         }
 
       class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
+        attr_reader _persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy?
+
+        def _persistence_strategy=: (
+          Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy
+        ) -> Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy
+
         attr_accessor categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?
 
         attr_accessor channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?
@@ -16,17 +23,30 @@ module Knockapi
         attr_accessor workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
 
         def initialize: (
+          ?_persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
           ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
           ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
           ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
         ) -> void
 
         def to_hash: -> {
+          _persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
           categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
           channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
           workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?
         }
 
+        type persistence_strategy = :merge | :replace
+
+        module PersistenceStrategy
+          extend Knockapi::Internal::Type::Enum
+
+          MERGE: :merge
+          REPLACE: :replace
+
+          def self?.values: -> ::Array[Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy]
+        end
+
         type category =
           bool
           | Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject

data/sig/knockapi/resources/objects.rbs

@@ -125,6 +125,7 @@ module Knockapi
         String collection,
         String object_id_,
         String id,
+        ?_persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,

data/sig/knockapi/resources/users.rbs

@@ -112,6 +112,7 @@ module Knockapi
       def set_preferences: (
         String user_id,
         String id,
+        ?_persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.11.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool