knockapi 1.5.0 → 1.7.0

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,131 @@ 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.
+          # 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]
+              )
+            )
+          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 that are set inline will be merged into any existing preferences
+            # rather than replacing them.
+            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_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/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/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/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/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).
@@ -283,7 +285,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 +307,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?,