knockapi 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88bed516b45f927d1fbb308a5772702f01c0730f771aa9beb5fd109cca94c737
-  data.tar.gz: 274df112dda80229e94e280b8a6254722b2a61a50137dbfbd6fd53c108e58077
+  metadata.gz: a8fe0e1d10c71e9d8525e72100489e37c46340b10b56774afdb51c91e42edd82
+  data.tar.gz: '033928a1fd5f48acc9a83424c4c9f57a63fedd47510d3f6be6be822c6b0784e1'
 SHA512:
-  metadata.gz: 32ef82b2c71ec00d58d059d53603022eee35219d9eb27478f5616c4d29dd229d08e7f6c2ef4b868c1030cc48e80953ca3c16d9538f0fbafab2f14a0d8d4346df
-  data.tar.gz: 4050f90d2fe88af42d1fe64e760d41d0d43b8671050277eaf254fda2cd618b0c5c39f0a6150bd10d75cdf015d653cca4cd4ff28e1eada6e599aaa6e6911d469d
+  metadata.gz: 1d390284ec7a8d3d6229b24536c000a93c86864fcd8280ce8c9d9c5b68ee3ca6d18cb9ec2a8cf0c69609e839941cef90e34b5e2355a0b77caf152c3db1a983b2
+  data.tar.gz: aa2d1c5854f1f2f747862ef533f4fa6867dc0379cfff4d7fb03b6d5197bc29ea4d634c595e26ab9c454c9da589217d4c84e037b26e019b9071df5a53ae73278e

data/CHANGELOG.md

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

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.6.0"
+gem "knockapi", "~> 1.7.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -44,6 +44,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,
@@ -51,6 +53,9 @@ module Knockapi
                    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.

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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 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).

data/rbi/knockapi/models/objects/bulk_set_params.rbi

@@ -77,6 +77,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(
@@ -121,6 +123,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/tenant_request.rbi

@@ -32,6 +32,8 @@ module Knockapi
       attr_accessor :channel_data
 
       # 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])
@@ -80,6 +82,8 @@ module Knockapi
         # A request to set channel data for a type of channel inline.
         channel_data: 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 settings for the tenant. Includes branding and preference set.
         settings: nil

data/rbi/knockapi/resources/objects.rbi

@@ -378,6 +378,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).

data/rbi/knockapi/resources/users/bulk.rbi

@@ -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.
         sig do
           params(
             user_ids: T::Array[String],
@@ -20,8 +19,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.
         sig do
           params(
             users: T::Array[Knockapi::InlineIdentifyUserRequest::OrHash],
@@ -35,9 +34,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.
         sig do
           params(
             preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash,

data/rbi/knockapi/resources/users.rbi

@@ -67,6 +67,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).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool