knockapi 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5f3a2c6174ea9d6f4a8203b2dc98ec7edfb5374cffd899a0b6b669257a7686
-  data.tar.gz: 2b4c45abf3420222039f6caacf508a530c4c8cac4196e325c353f927f60e5b6c
+  metadata.gz: a8fe0e1d10c71e9d8525e72100489e37c46340b10b56774afdb51c91e42edd82
+  data.tar.gz: '033928a1fd5f48acc9a83424c4c9f57a63fedd47510d3f6be6be822c6b0784e1'
 SHA512:
-  metadata.gz: '0409be38f4fe4c66806657b1821f9bd66f4191a5c631cbbd6110c4ab60a7d3b3613c6fa8909656b85dfd99723f953172a4561d7a5addb8fdc61aa00882ea71a1'
-  data.tar.gz: 8bb6ec2864fa22a0482c4600d911fbd4e7d38c6e4b58b0c6f7f71163781d588fb8d1bd674a0bbd4c6dd1e399ed43c5f930b73c407636b5b6fae443dd5e5fbd74
+  metadata.gz: 1d390284ec7a8d3d6229b24536c000a93c86864fcd8280ce8c9d9c5b68ee3ca6d18cb9ec2a8cf0c69609e839941cef90e34b5e2355a0b77caf152c3db1a983b2
+  data.tar.gz: aa2d1c5854f1f2f747862ef533f4fa6867dc0379cfff4d7fb03b6d5197bc29ea4d634c595e26ab9c454c9da589217d4c84e037b26e019b9071df5a53ae73278e

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 1.7.0 (2025-06-12)
+
+Full Changelog: [v1.6.0...v1.7.0](https://github.com/knocklabs/knock-ruby/compare/v1.6.0...v1.7.0)
+
+### Features
+
+* **api:** api update ([ccc6df0](https://github.com/knocklabs/knock-ruby/commit/ccc6df0d616d93198a605ec4c986e03369a8843b))
+* **api:** api update ([fddf322](https://github.com/knocklabs/knock-ruby/commit/fddf3226958f8a212c5c3fa4d0dc8f72c01dcbe5))
+
+
+### Chores
+
+* **ci:** link to correct github repo ([acd8f88](https://github.com/knocklabs/knock-ruby/commit/acd8f8882a660c449b45113b848944327382f1a0))
+
+## 1.6.0 (2025-06-06)
+
+Full Changelog: [v1.5.0...v1.6.0](https://github.com/knocklabs/knock-ruby/compare/v1.5.0...v1.6.0)
+
+### Features
+
+* **api:** api update ([53aa9c9](https://github.com/knocklabs/knock-ruby/commit/53aa9c9ebd4a8e7be2fd5bdf08a4b749f6b9d116))
+
+
+### Bug Fixes
+
+* default content-type for text in multi-part formdata uploads should be text/plain ([de655f0](https://github.com/knocklabs/knock-ruby/commit/de655f0dd9194b4c30d7ad26e2da98f6cba51a0f))
+
 ## 1.5.0 (2025-06-04)
 
 Full Changelog: [v1.4.0...v1.5.0](https://github.com/knocklabs/knock-ruby/compare/v1.4.0...v1.5.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 "knockapi", "~> 1.5.0"
+gem "knockapi", "~> 1.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/internal/util.rb

@@ -497,7 +497,7 @@ module Knockapi
         # @param closing [Array<Proc>]
         # @param content_type [String, nil]
         private def write_multipart_content(y, val:, closing:, content_type: nil)
-          content_type ||= "application/octet-stream"
+          content_line = "Content-Type: %s\r\n\r\n"
 
           case val
           in Knockapi::FilePart
@@ -508,24 +508,21 @@ module Knockapi
               content_type: val.content_type
             )
           in Pathname
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             io = val.open(binmode: true)
             closing << io.method(:close)
             IO.copy_stream(io, y)
           in IO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             IO.copy_stream(val, y)
           in StringIO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             y << val.string
-          in String
-            y << "Content-Type: #{content_type}\r\n\r\n"
-            y << val.to_s
           in -> { primitive?(_1) }
-            y << "Content-Type: text/plain\r\n\r\n"
+            y << format(content_line, content_type || "text/plain")
             y << val.to_s
           else
-            y << "Content-Type: application/json\r\n\r\n"
+            y << format(content_line, content_type || "application/json")
             y << JSON.generate(val)
           end
           y << "\r\n"
@@ -563,6 +560,8 @@ module Knockapi
 
         # @api private
         #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
+        #
         # @param body [Object]
         #
         # @return [Array(String, Enumerable<String>)]

data/lib/knockapi/models/identify_user_request.rb

@@ -52,6 +52,8 @@ module Knockapi
 
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
+      #   Preferences that are set inline will be merged into any existing preferences
+      #   rather than replacing them.
       #
       #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,

data/lib/knockapi/models/inline_identify_user_request.rb

@@ -58,6 +58,8 @@ module Knockapi
 
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
+      #   Preferences that are set inline will be merged into any existing preferences
+      #   rather than replacing them.
       #
       #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,

data/lib/knockapi/models/inline_object_request.rb

@@ -33,6 +33,8 @@ module Knockapi
 
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
+      #   Preferences that are set inline will be merged into any existing preferences
+      #   rather than replacing them.
       #
       #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
@@ -40,6 +42,9 @@ module Knockapi
                nil?: true
 
       # @!method initialize(id:, collection:, channel_data: nil, created_at: nil, preferences: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::InlineObjectRequest} for more details.
+      #
       #   A custom [Object](/concepts/objects) entity which belongs to a collection.
       #
       #   @param id [String] Unique identifier for the object.

data/lib/knockapi/models/object_set_params.rb

@@ -25,6 +25,8 @@ module Knockapi
 
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
+      #   Preferences that are set inline will be merged into any existing preferences
+      #   rather than replacing them.
       #
       #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,

data/lib/knockapi/models/objects/bulk_set_params.rb

@@ -11,13 +11,61 @@ module Knockapi
         # @!attribute objects
         #   A list of objects.
         #
-        #   @return [Array<Knockapi::Models::InlineObjectRequest>]
-        required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineObjectRequest] }
+        #   @return [Array<Knockapi::Models::Objects::BulkSetParams::Object>]
+        required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkSetParams::Object] }
 
         # @!method initialize(objects:, request_options: {})
-        #   @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
+        #   @param objects [Array<Knockapi::Models::Objects::BulkSetParams::Object>] A list of objects.
         #
         #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class Object < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the object.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute channel_data
+          #   A request to set channel data for a type of channel inline.
+          #
+          #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
+          optional :channel_data,
+                   -> {
+                     Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
+                   },
+                   nil?: true
+
+          # @!attribute created_at
+          #   Timestamp when the resource was created.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time, nil?: true
+
+          # @!attribute preferences
+          #   Inline set preferences for a recipient, where the key is the preference set id.
+          #   Preferences that are set inline will be merged into any existing preferences
+          #   rather than replacing them.
+          #
+          #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
+          optional :preferences,
+                   -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
+                   nil?: true
+
+          # @!method initialize(id:, channel_data: nil, created_at: nil, preferences: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Objects::BulkSetParams::Object} for more details.
+          #
+          #   A custom [Object](/concepts/objects) entity which belongs to a collection.
+          #
+          #   @param id [String] Unique identifier for the object.
+          #
+          #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+          #
+          #   @param created_at [Time, nil] Timestamp when the resource was created.
+          #
+          #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+        end
       end
     end
   end

data/lib/knockapi/models/schedule_list_params.rb

@@ -32,10 +32,10 @@ module Knockapi
       optional :page_size, Integer
 
       # @!attribute recipients
-      #   Filter by recipient IDs.
+      #   Filter by recipient references.
       #
-      #   @return [Array<String>, nil]
-      optional :recipients, Knockapi::Internal::Type::ArrayOf[String]
+      #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
+      optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
 
       # @!attribute tenant
       #   Filter by tenant ID.
@@ -52,7 +52,7 @@ module Knockapi
       #
       #   @param page_size [Integer] The number of items per page.
       #
-      #   @param recipients [Array<String>] Filter by recipient IDs.
+      #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Filter by recipient references.
       #
       #   @param tenant [String] Filter by tenant ID.
       #

data/lib/knockapi/models/schedule_repeat_rule.rb

@@ -3,18 +3,18 @@
 module Knockapi
   module Models
     class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
-      # @!attribute _typename
-      #   The typename of the schema.
-      #
-      #   @return [String]
-      required :_typename, String, api_name: :__typename
-
       # @!attribute frequency
       #   The frequency of the schedule.
       #
       #   @return [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency]
       required :frequency, enum: -> { Knockapi::ScheduleRepeatRule::Frequency }
 
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String, nil]
+      optional :_typename, String, api_name: :__typename
+
       # @!attribute day_of_month
       #   The day of the month to repeat the schedule.
       #
@@ -47,13 +47,13 @@ module Knockapi
       #   @return [Integer, nil]
       optional :minutes, Integer, nil?: true
 
-      # @!method initialize(_typename:, frequency:, day_of_month: nil, days: nil, hours: nil, interval: nil, minutes: nil)
+      # @!method initialize(frequency:, _typename: nil, day_of_month: nil, days: nil, hours: nil, interval: nil, minutes: nil)
       #   The repeat rule for the schedule.
       #
-      #   @param _typename [String] The typename of the schema.
-      #
       #   @param frequency [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency] The frequency of the schedule.
       #
+      #   @param _typename [String] The typename of the schema.
+      #
       #   @param day_of_month [Integer, nil] The day of the month to repeat the schedule.
       #
       #   @param days [Array<Symbol, Knockapi::Models::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.

data/lib/knockapi/models/tenant_request.rb

@@ -21,6 +21,8 @@ module Knockapi
 
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
+      #   Preferences that are set inline will be merged into any existing preferences
+      #   rather than replacing them.
       #
       #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
@@ -34,6 +36,9 @@ module Knockapi
       optional :settings, -> { Knockapi::TenantRequest::Settings }
 
       # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::TenantRequest} for more details.
+      #
       #   A tenant to be set in the system. You can supply any additional properties on
       #   the tenant object.
       #

data/lib/knockapi/models/tenant_set_params.rb

@@ -17,25 +17,15 @@ module Knockapi
                },
                nil?: true
 
-      # @!attribute preferences
-      #   Inline set preferences for a recipient, where the key is the preference set id.
-      #
-      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
-      optional :preferences,
-               -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
-               nil?: true
-
       # @!attribute settings
       #   The settings for the tenant. Includes branding and preference set.
       #
       #   @return [Knockapi::Models::TenantSetParams::Settings, nil]
       optional :settings, -> { Knockapi::TenantSetParams::Settings }
 
-      # @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
+      # @!method initialize(channel_data: nil, settings: nil, request_options: {})
       #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
-      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
-      #
       #   @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]

data/lib/knockapi/models/user_list_subscriptions_params.rb

@@ -27,10 +27,10 @@ module Knockapi
                -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListSubscriptionsParams::Include] }
 
       # @!attribute objects
-      #   Only returns subscriptions for the specified object GIDs.
+      #   Only returns subscriptions for the specified object references.
       #
-      #   @return [Array<String>, nil]
-      optional :objects, Knockapi::Internal::Type::ArrayOf[String]
+      #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
+      optional :objects, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
 
       # @!attribute page_size
       #   The number of items per page.
@@ -45,7 +45,7 @@ module Knockapi
       #
       #   @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
       #
-      #   @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
+      #   @param objects [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Only returns subscriptions for the specified object references.
       #
       #   @param page_size [Integer] The number of items per page.
       #

data/lib/knockapi/resources/objects/bulk.rb

@@ -62,7 +62,7 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
+        # @param objects [Array<Knockapi::Models::Objects::BulkSetParams::Object>] A list of objects.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/knockapi/resources/schedules.rb

@@ -103,7 +103,7 @@ module Knockapi
       #
       # @param page_size [Integer] The number of items per page.
       #
-      # @param recipients [Array<String>] Filter by recipient IDs.
+      # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Filter by recipient references.
       #
       # @param tenant [String] Filter by tenant ID.
       #

data/lib/knockapi/resources/tenants.rb

@@ -80,14 +80,12 @@ module Knockapi
       # Sets a tenant within an environment, performing an upsert operation. Any
       # existing properties will be merged with the incoming properties.
       #
-      # @overload set(id, channel_data: nil, preferences: nil, settings: nil, request_options: {})
+      # @overload set(id, channel_data: nil, settings: nil, request_options: {})
       #
       # @param id [String] The unique identifier for the tenant.
       #
       # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
-      # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
-      #
       # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/knockapi/resources/users/bulk.rb

@@ -4,8 +4,7 @@ module Knockapi
   module Resources
     class Users
       class Bulk
-        # Deletes multiple users in a single operation. Accepts up to 100 user IDs to
-        # delete and returns a bulk operation that can be queried for progress.
+        # Permanently deletes up to 1,000 users at a time.
         #
         # @overload delete(user_ids:, request_options: {})
         #
@@ -28,8 +27,8 @@ module Knockapi
         end
 
         # Identifies multiple users in a single operation. Allows creating or updating up
-        # to 100 users in a single batch with various properties, preferences, and channel
-        # data.
+        # to 1,000 users in a single batch with various properties, preferences, and
+        # channel data.
         #
         # @overload identify(users:, request_options: {})
         #
@@ -51,9 +50,11 @@ module Knockapi
           )
         end
 
-        # Sets preferences for multiple users in a single operation. Supports either
-        # setting the same preferences for multiple users or specific preferences for each
-        # user.
+        # Bulk sets the preferences for up to 1,000 users at a time. The preference
+        # set `:id` can be either `default` or a `tenant.id`. Learn more
+        # about [per-tenant preferences](/preferences/tenant-preferences). Note that this
+        # is a destructive operation and will replace any existing users' preferences with
+        # the preferences sent.
         #
         # @overload set_preferences(preferences:, user_ids:, request_options: {})
         #

data/lib/knockapi/resources/users.rb

@@ -298,7 +298,7 @@ module Knockapi
       #
       # @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
       #
-      # @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
+      # @param objects [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Only returns subscriptions for the specified object references.
       #
       # @param page_size [Integer] The number of items per page.
       #

data/lib/knockapi/version.rb

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

data/rbi/knockapi/internal/util.rbi

@@ -332,6 +332,8 @@ module Knockapi
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end

data/rbi/knockapi/models/identify_user_request.rbi

@@ -53,6 +53,8 @@ module Knockapi
       attr_accessor :phone_number
 
       # Inline set preferences for a recipient, where the key is the preference set id.
+      # Preferences that are set inline will be merged into any existing preferences
+      # rather than replacing them.
       sig do
         returns(
           T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
@@ -118,6 +120,8 @@ module Knockapi
         # user (required for SMS channels).
         phone_number: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
+        # Preferences that are set inline will be merged into any existing preferences
+        # rather than replacing them.
         preferences: nil,
         # The timezone of the user. Must be a
         # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

data/rbi/knockapi/models/inline_identify_user_request.rbi

@@ -60,6 +60,8 @@ module Knockapi
       attr_accessor :phone_number
 
       # Inline set preferences for a recipient, where the key is the preference set id.
+      # Preferences that are set inline will be merged into any existing preferences
+      # rather than replacing them.
       sig do
         returns(
           T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
@@ -129,6 +131,8 @@ module Knockapi
         # user (required for SMS channels).
         phone_number: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
+        # Preferences that are set inline will be merged into any existing preferences
+        # rather than replacing them.
         preferences: nil,
         # The timezone of the user. Must be a
         # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

data/rbi/knockapi/models/inline_object_request.rbi

@@ -40,6 +40,8 @@ module Knockapi
       attr_accessor :created_at
 
       # Inline set preferences for a recipient, where the key is the preference set id.
+      # Preferences that are set inline will be merged into any existing preferences
+      # rather than replacing them.
       sig do
         returns(
           T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
@@ -85,6 +87,8 @@ module Knockapi
         # Timestamp when the resource was created.
         created_at: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
+        # Preferences that are set inline will be merged into any existing preferences
+        # rather than replacing them.
         preferences: nil
       )
       end

data/rbi/knockapi/models/object_set_params.rbi

@@ -53,6 +53,8 @@ module Knockapi
       attr_accessor :locale
 
       # Inline set preferences for a recipient, where the key is the preference set id.
+      # Preferences that are set inline will be merged into any existing preferences
+      # rather than replacing them.
       sig do
         returns(
           T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
@@ -102,6 +104,8 @@ module Knockapi
         # [message localization](/concepts/translations).
         locale: nil,
         # Inline set preferences for a recipient, where the key is the preference set id.
+        # Preferences that are set inline will be merged into any existing preferences
+        # rather than replacing them.
         preferences: nil,
         # The timezone of the object. Must be a
         # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).