knockapi 1.10.3 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247db1a9c4387aa27502f288b58a3db837203123f8986c2a39cd11c53da8b62d
-  data.tar.gz: 797f6bc3a516d4ad8be7dfdfc040a5805e61b251b85ed0fb7426e77593ce3859
+  metadata.gz: fb73648101e7d2bd451a7d998eb5ded40adcd662a9ca06e29ec4f2f1b4c479dc
+  data.tar.gz: 47715ed958cb260beff0d347ea7e8783a05181e1d34c4394656ba6ac50c3d33a
 SHA512:
-  metadata.gz: 514637c1db0be816f3e9913bc3a9cc138eebee03aedba7628ffdc290c5ab4b241a4cc1ebf0ac856c875a5382f313c0e3b2d1f6d5dd9352b957384d195d4749a4
-  data.tar.gz: 3e0acf187a631fa5a55f3e4401f54d204ac51f6d97a2f9ec7d6ed3d5e3082bf737f48724b5a3285437ecbf6cb829cf6f1a32cdbb746338976c9a6da8730b766b
+  metadata.gz: 94968e7c435833897b9d5c574f1f2f81556c937661eeaf1f6854802379fddc9bf4e4f70ebb3096fdc84656361b29e70540956ae6c30d355fdd533102c777f559
+  data.tar.gz: 708aaf055317502fea383da4f0e3350ac35bd08eb07734beffabf71439d46666c67b334eaa5d83afc75f79c83bae241aa949b8d8e8f086257406828f4e352cfa

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)

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.3"
+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/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.3"
+  VERSION = "1.11.0"
 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/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.3
+  version: 1.11.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-13 00:00:00.000000000 Z
+date: 2025-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool