knockapi 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5f3a2c6174ea9d6f4a8203b2dc98ec7edfb5374cffd899a0b6b669257a7686
-  data.tar.gz: 2b4c45abf3420222039f6caacf508a530c4c8cac4196e325c353f927f60e5b6c
+  metadata.gz: 88bed516b45f927d1fbb308a5772702f01c0730f771aa9beb5fd109cca94c737
+  data.tar.gz: 274df112dda80229e94e280b8a6254722b2a61a50137dbfbd6fd53c108e58077
 SHA512:
-  metadata.gz: '0409be38f4fe4c66806657b1821f9bd66f4191a5c631cbbd6110c4ab60a7d3b3613c6fa8909656b85dfd99723f953172a4561d7a5addb8fdc61aa00882ea71a1'
-  data.tar.gz: 8bb6ec2864fa22a0482c4600d911fbd4e7d38c6e4b58b0c6f7f71163781d588fb8d1bd674a0bbd4c6dd1e399ed43c5f930b73c407636b5b6fae443dd5e5fbd74
+  metadata.gz: 32ef82b2c71ec00d58d059d53603022eee35219d9eb27478f5616c4d29dd229d08e7f6c2ef4b868c1030cc48e80953ca3c16d9538f0fbafab2f14a0d8d4346df
+  data.tar.gz: 4050f90d2fe88af42d1fe64e760d41d0d43b8671050277eaf254fda2cd618b0c5c39f0a6150bd10d75cdf015d653cca4cd4ff28e1eada6e599aaa6e6911d469d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 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.6.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/objects/bulk_set_params.rb

@@ -11,13 +11,56 @@ 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.
+          #
+          #   @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)
+          #   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_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.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.6.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/objects/bulk_set_params.rbi

@@ -13,12 +13,12 @@ module Knockapi
           end
 
         # A list of objects.
-        sig { returns(T::Array[Knockapi::InlineObjectRequest]) }
+        sig { returns(T::Array[Knockapi::Objects::BulkSetParams::Object]) }
         attr_accessor :objects
 
         sig do
           params(
-            objects: T::Array[Knockapi::InlineObjectRequest::OrHash],
+            objects: T::Array[Knockapi::Objects::BulkSetParams::Object::OrHash],
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -32,13 +32,127 @@ module Knockapi
         sig do
           override.returns(
             {
-              objects: T::Array[Knockapi::InlineObjectRequest],
+              objects: T::Array[Knockapi::Objects::BulkSetParams::Object],
               request_options: Knockapi::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        class Object < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Objects::BulkSetParams::Object,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for the object.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # A request to set channel data for a type of channel inline.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              )
+            )
+          end
+          attr_accessor :channel_data
+
+          # Timestamp when the resource was created.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :created_at
+
+          # Inline set preferences for a recipient, where the key is the preference set id.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              )
+            )
+          end
+          attr_accessor :preferences
+
+          # A custom [Object](/concepts/objects) entity which belongs to a collection.
+          sig do
+            params(
+              id: String,
+              channel_data:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      Knockapi::Recipients::PushChannelData::OrHash,
+                      Knockapi::Recipients::OneSignalChannelData::OrHash,
+                      Knockapi::Recipients::SlackChannelData::OrHash,
+                      Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                      Knockapi::Recipients::DiscordChannelData::OrHash
+                    )
+                  ]
+                ),
+              created_at: T.nilable(Time),
+              preferences:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Knockapi::Recipients::PreferenceSetRequest::OrHash
+                  ]
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for the object.
+            id:,
+            # A request to set channel data for a type of channel inline.
+            channel_data: nil,
+            # Timestamp when the resource was created.
+            created_at: nil,
+            # Inline set preferences for a recipient, where the key is the preference set id.
+            preferences: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                channel_data:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        Knockapi::Recipients::PushChannelData,
+                        Knockapi::Recipients::OneSignalChannelData,
+                        Knockapi::Recipients::SlackChannelData,
+                        Knockapi::Recipients::MsTeamsChannelData,
+                        Knockapi::Recipients::DiscordChannelData
+                      )
+                    ]
+                  ),
+                created_at: T.nilable(Time),
+                preferences:
+                  T.nilable(
+                    T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/knockapi/models/schedule_list_params.rbi

@@ -36,11 +36,29 @@ module Knockapi
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
-      # Filter by recipient IDs.
-      sig { returns(T.nilable(T::Array[String])) }
+      # Filter by recipient references.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       attr_reader :recipients
 
-      sig { params(recipients: T::Array[String]).void }
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
+      end
       attr_writer :recipients
 
       # Filter by tenant ID.
@@ -56,7 +74,13 @@ module Knockapi
           after: String,
           before: String,
           page_size: Integer,
-          recipients: T::Array[String],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           tenant: String,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -70,7 +94,7 @@ module Knockapi
         before: nil,
         # The number of items per page.
         page_size: nil,
-        # Filter by recipient IDs.
+        # Filter by recipient references.
         recipients: nil,
         # Filter by tenant ID.
         tenant: nil,
@@ -85,7 +109,10 @@ module Knockapi
             after: String,
             before: String,
             page_size: Integer,
-            recipients: T::Array[String],
+            recipients:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
             tenant: String,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/schedule_repeat_rule.rbi

@@ -8,14 +8,17 @@ module Knockapi
           T.any(Knockapi::ScheduleRepeatRule, Knockapi::Internal::AnyHash)
         end
 
-      # The typename of the schema.
-      sig { returns(String) }
-      attr_accessor :_typename
-
       # The frequency of the schedule.
       sig { returns(Knockapi::ScheduleRepeatRule::Frequency::OrSymbol) }
       attr_accessor :frequency
 
+      # The typename of the schema.
+      sig { returns(T.nilable(String)) }
+      attr_reader :_typename
+
+      sig { params(_typename: String).void }
+      attr_writer :_typename
+
       # The day of the month to repeat the schedule.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :day_of_month
@@ -46,8 +49,8 @@ module Knockapi
       # The repeat rule for the schedule.
       sig do
         params(
-          _typename: String,
           frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
+          _typename: String,
           day_of_month: T.nilable(Integer),
           days:
             T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),
@@ -57,10 +60,10 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
-        # The typename of the schema.
-        _typename:,
         # The frequency of the schedule.
         frequency:,
+        # The typename of the schema.
+        _typename: nil,
         # The day of the month to repeat the schedule.
         day_of_month: nil,
         # The days of the week to repeat the schedule.
@@ -77,8 +80,8 @@ module Knockapi
       sig do
         override.returns(
           {
-            _typename: String,
             frequency: Knockapi::ScheduleRepeatRule::Frequency::OrSymbol,
+            _typename: String,
             day_of_month: T.nilable(Integer),
             days:
               T.nilable(T::Array[Knockapi::ScheduleRepeatRule::Day::OrSymbol]),

data/rbi/knockapi/models/tenant_set_params.rbi

@@ -30,14 +30,6 @@ module Knockapi
       end
       attr_accessor :channel_data
 
-      # Inline set preferences for a recipient, where the key is the preference set id.
-      sig do
-        returns(
-          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
-        )
-      end
-      attr_accessor :preferences
-
       # The settings for the tenant. Includes branding and preference set.
       sig { returns(T.nilable(Knockapi::TenantSetParams::Settings)) }
       attr_reader :settings
@@ -60,13 +52,6 @@ module Knockapi
                 )
               ]
             ),
-          preferences:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Knockapi::Recipients::PreferenceSetRequest::OrHash
-              ]
-            ),
           settings: Knockapi::TenantSetParams::Settings::OrHash,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -74,8 +59,6 @@ module Knockapi
       def self.new(
         # 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: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}
@@ -98,10 +81,6 @@ module Knockapi
                   )
                 ]
               ),
-            preferences:
-              T.nilable(
-                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
-              ),
             settings: Knockapi::TenantSetParams::Settings,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/user_list_subscriptions_params.rbi

@@ -46,11 +46,29 @@ module Knockapi
       end
       attr_writer :include
 
-      # Only returns subscriptions for the specified object GIDs.
-      sig { returns(T.nilable(T::Array[String])) }
+      # Only returns subscriptions for the specified object references.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
       attr_reader :objects
 
-      sig { params(objects: T::Array[String]).void }
+      sig do
+        params(
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ]
+        ).void
+      end
       attr_writer :objects
 
       # The number of items per page.
@@ -66,7 +84,13 @@ module Knockapi
           before: String,
           include:
             T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
-          objects: T::Array[String],
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           page_size: Integer,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -78,7 +102,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # Only returns subscriptions for the specified object GIDs.
+        # Only returns subscriptions for the specified object references.
         objects: nil,
         # The number of items per page.
         page_size: nil,
@@ -95,7 +119,10 @@ module Knockapi
               T::Array[
                 Knockapi::UserListSubscriptionsParams::Include::OrSymbol
               ],
-            objects: T::Array[String],
+            objects:
+              T::Array[
+                T.any(String, Knockapi::RecipientReference::ObjectReference)
+              ],
             page_size: Integer,
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/resources/objects/bulk.rbi

@@ -49,7 +49,7 @@ module Knockapi
         sig do
           params(
             collection: String,
-            objects: T::Array[Knockapi::InlineObjectRequest::OrHash],
+            objects: T::Array[Knockapi::Objects::BulkSetParams::Object::OrHash],
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(Knockapi::BulkOperation)
         end

data/rbi/knockapi/resources/schedules.rbi

@@ -118,7 +118,13 @@ module Knockapi
           after: String,
           before: String,
           page_size: Integer,
-          recipients: T::Array[String],
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           tenant: String,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Internal::EntriesCursor[Knockapi::Schedule])
@@ -132,7 +138,7 @@ module Knockapi
         before: nil,
         # The number of items per page.
         page_size: nil,
-        # Filter by recipient IDs.
+        # Filter by recipient references.
         recipients: nil,
         # Filter by tenant ID.
         tenant: nil,

data/rbi/knockapi/resources/tenants.rbi

@@ -78,13 +78,6 @@ module Knockapi
                 )
               ]
             ),
-          preferences:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Knockapi::Recipients::PreferenceSetRequest::OrHash
-              ]
-            ),
           settings: Knockapi::TenantSetParams::Settings::OrHash,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(Knockapi::Tenant)
@@ -94,8 +87,6 @@ module Knockapi
         id,
         # 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: nil,
         # The settings for the tenant. Includes branding and preference set.
         settings: nil,
         request_options: {}

data/rbi/knockapi/resources/users.rbi

@@ -283,7 +283,13 @@ module Knockapi
           before: String,
           include:
             T::Array[Knockapi::UserListSubscriptionsParams::Include::OrSymbol],
-          objects: T::Array[String],
+          objects:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::RecipientReference::ObjectReference::OrHash
+              )
+            ],
           page_size: Integer,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(
@@ -299,7 +305,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # Only returns subscriptions for the specified object GIDs.
+        # Only returns subscriptions for the specified object references.
         objects: nil,
         # The number of items per page.
         page_size: nil,

data/sig/knockapi/models/objects/bulk_set_params.rbs

@@ -2,24 +2,56 @@ module Knockapi
   module Models
     module Objects
       type bulk_set_params =
-        { objects: ::Array[Knockapi::InlineObjectRequest] }
+        { objects: ::Array[Knockapi::Objects::BulkSetParams::Object] }
         & Knockapi::Internal::Type::request_parameters
 
       class BulkSetParams < Knockapi::Internal::Type::BaseModel
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        attr_accessor objects: ::Array[Knockapi::InlineObjectRequest]
+        attr_accessor objects: ::Array[Knockapi::Objects::BulkSetParams::Object]
 
         def initialize: (
-          objects: ::Array[Knockapi::InlineObjectRequest],
+          objects: ::Array[Knockapi::Objects::BulkSetParams::Object],
           ?request_options: Knockapi::request_opts
         ) -> void
 
         def to_hash: -> {
-          objects: ::Array[Knockapi::InlineObjectRequest],
+          objects: ::Array[Knockapi::Objects::BulkSetParams::Object],
           request_options: Knockapi::RequestOptions
         }
+
+        type object =
+          {
+            id: String,
+            channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            created_at: Time?,
+            preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          }
+
+        class Object < Knockapi::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
+
+          attr_accessor created_at: Time?
+
+          attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+
+          def initialize: (
+            id: String,
+            ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            ?created_at: Time?,
+            ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
+            created_at: Time?,
+            preferences: Knockapi::Models::Recipients::inline_preference_set_request?
+          }
+        end
       end
     end
   end

data/sig/knockapi/models/schedule_list_params.rbs

@@ -6,7 +6,7 @@ module Knockapi
         after: String,
         before: String,
         page_size: Integer,
-        recipients: ::Array[String],
+        recipients: ::Array[Knockapi::Models::recipient_reference],
         tenant: String
       }
       & Knockapi::Internal::Type::request_parameters
@@ -29,9 +29,11 @@ module Knockapi
 
       def page_size=: (Integer) -> Integer
 
-      attr_reader recipients: ::Array[String]?
+      attr_reader recipients: ::Array[Knockapi::Models::recipient_reference]?
 
-      def recipients=: (::Array[String]) -> ::Array[String]
+      def recipients=: (
+        ::Array[Knockapi::Models::recipient_reference]
+      ) -> ::Array[Knockapi::Models::recipient_reference]
 
       attr_reader tenant: String?
 
@@ -42,7 +44,7 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?page_size: Integer,
-        ?recipients: ::Array[String],
+        ?recipients: ::Array[Knockapi::Models::recipient_reference],
         ?tenant: String,
         ?request_options: Knockapi::request_opts
       ) -> void
@@ -52,7 +54,7 @@ module Knockapi
         after: String,
         before: String,
         page_size: Integer,
-        recipients: ::Array[String],
+        recipients: ::Array[Knockapi::Models::recipient_reference],
         tenant: String,
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/schedule_repeat_rule.rbs

@@ -2,8 +2,8 @@ module Knockapi
   module Models
     type schedule_repeat_rule =
       {
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        _typename: String,
         day_of_month: Integer?,
         days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         hours: Integer?,
@@ -12,10 +12,12 @@ module Knockapi
       }
 
     class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
-      attr_accessor _typename: String
-
       attr_accessor frequency: Knockapi::Models::ScheduleRepeatRule::frequency
 
+      attr_reader _typename: String?
+
+      def _typename=: (String) -> String
+
       attr_accessor day_of_month: Integer?
 
       attr_accessor days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?
@@ -29,8 +31,8 @@ module Knockapi
       attr_accessor minutes: Integer?
 
       def initialize: (
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        ?_typename: String,
         ?day_of_month: Integer?,
         ?days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         ?hours: Integer?,
@@ -39,8 +41,8 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
-        _typename: String,
         frequency: Knockapi::Models::ScheduleRepeatRule::frequency,
+        _typename: String,
         day_of_month: Integer?,
         days: ::Array[Knockapi::Models::ScheduleRepeatRule::day]?,
         hours: Integer?,

data/sig/knockapi/models/tenant_set_params.rbs

@@ -3,7 +3,6 @@ module Knockapi
     type tenant_set_params =
       {
         channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
-        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
         settings: Knockapi::TenantSetParams::Settings
       }
       & Knockapi::Internal::Type::request_parameters
@@ -14,8 +13,6 @@ module Knockapi
 
       attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
 
-      attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
-
       attr_reader settings: Knockapi::TenantSetParams::Settings?
 
       def settings=: (
@@ -24,14 +21,12 @@ module Knockapi
 
       def initialize: (
         ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
-        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
         ?settings: Knockapi::TenantSetParams::Settings,
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
         channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
-        preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
         settings: Knockapi::TenantSetParams::Settings,
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/user_list_subscriptions_params.rbs

@@ -5,7 +5,7 @@ module Knockapi
         after: String,
         before: String,
         include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
-        objects: ::Array[String],
+        objects: ::Array[Knockapi::Models::recipient_reference],
         page_size: Integer
       }
       & Knockapi::Internal::Type::request_parameters
@@ -28,9 +28,11 @@ module Knockapi
         ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
       ) -> ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
 
-      attr_reader objects: ::Array[String]?
+      attr_reader objects: ::Array[Knockapi::Models::recipient_reference]?
 
-      def objects=: (::Array[String]) -> ::Array[String]
+      def objects=: (
+        ::Array[Knockapi::Models::recipient_reference]
+      ) -> ::Array[Knockapi::Models::recipient_reference]
 
       attr_reader page_size: Integer?
 
@@ -40,7 +42,7 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
-        ?objects: ::Array[String],
+        ?objects: ::Array[Knockapi::Models::recipient_reference],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
       ) -> void
@@ -49,7 +51,7 @@ module Knockapi
         after: String,
         before: String,
         include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
-        objects: ::Array[String],
+        objects: ::Array[Knockapi::Models::recipient_reference],
         page_size: Integer,
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/resources/objects/bulk.rbs

@@ -16,7 +16,7 @@ module Knockapi
 
         def set: (
           String collection,
-          objects: ::Array[Knockapi::InlineObjectRequest],
+          objects: ::Array[Knockapi::Objects::BulkSetParams::Object],
           ?request_options: Knockapi::request_opts
         ) -> Knockapi::BulkOperation
 

data/sig/knockapi/resources/schedules.rbs

@@ -31,7 +31,7 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?page_size: Integer,
-        ?recipients: ::Array[String],
+        ?recipients: ::Array[Knockapi::Models::recipient_reference],
         ?tenant: String,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]

data/sig/knockapi/resources/tenants.rbs

@@ -25,7 +25,6 @@ module Knockapi
       def set: (
         String id,
         ?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
-        ?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
         ?settings: Knockapi::TenantSetParams::Settings,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Tenant

data/sig/knockapi/resources/users.rbs

@@ -91,7 +91,7 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
-        ?objects: ::Array[String],
+        ?objects: ::Array[Knockapi::Models::recipient_reference],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Internal::EntriesCursor[Knockapi::Recipients::Subscription]

metadata

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