knockapi 1.38.0 → 1.40.0

data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Messages
-      class BatchMarkAsReadParams < Knockapi::Internal::Type::BaseModel
+      class BatchMarkAsReadParams < Knockapi::Models::Messages::BatchMessagesStatusRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -15,31 +15,15 @@ module Knockapi
             )
           end
 
-        # The message IDs to update the status of.
-        sig { returns(T::Array[String]) }
-        attr_accessor :message_ids
-
         sig do
-          params(
-            message_ids: T::Array[String],
-            request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: Knockapi::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The message IDs to update the status of.
-          message_ids:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            {
-              message_ids: T::Array[String],
-              request_options: Knockapi::RequestOptions
-            }
-          )
-        end
+        sig { override.returns({ request_options: Knockapi::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Messages
-      class BatchMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
+      class BatchMarkAsSeenParams < Knockapi::Models::Messages::BatchMessagesStatusRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -15,31 +15,15 @@ module Knockapi
             )
           end
 
-        # The message IDs to update the status of.
-        sig { returns(T::Array[String]) }
-        attr_accessor :message_ids
-
         sig do
-          params(
-            message_ids: T::Array[String],
-            request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: Knockapi::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The message IDs to update the status of.
-          message_ids:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            {
-              message_ids: T::Array[String],
-              request_options: Knockapi::RequestOptions
-            }
-          )
-        end
+        sig { override.returns({ request_options: Knockapi::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Messages
-      class BatchMarkAsUnreadParams < Knockapi::Internal::Type::BaseModel
+      class BatchMarkAsUnreadParams < Knockapi::Models::Messages::BatchMessagesStatusRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -15,31 +15,15 @@ module Knockapi
             )
           end
 
-        # The message IDs to update the status of.
-        sig { returns(T::Array[String]) }
-        attr_accessor :message_ids
-
         sig do
-          params(
-            message_ids: T::Array[String],
-            request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: Knockapi::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The message IDs to update the status of.
-          message_ids:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            {
-              message_ids: T::Array[String],
-              request_options: Knockapi::RequestOptions
-            }
-          )
-        end
+        sig { override.returns({ request_options: Knockapi::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Messages
-      class BatchMarkAsUnseenParams < Knockapi::Internal::Type::BaseModel
+      class BatchMarkAsUnseenParams < Knockapi::Models::Messages::BatchMessagesStatusRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -15,31 +15,15 @@ module Knockapi
             )
           end
 
-        # The message IDs to update the status of.
-        sig { returns(T::Array[String]) }
-        attr_accessor :message_ids
-
         sig do
-          params(
-            message_ids: T::Array[String],
-            request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: Knockapi::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The message IDs to update the status of.
-          message_ids:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            {
-              message_ids: T::Array[String],
-              request_options: Knockapi::RequestOptions
-            }
-          )
-        end
+        sig { override.returns({ request_options: Knockapi::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/knockapi/models/messages/batch_messages_status_request.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Messages
+      class BatchMessagesStatusRequest < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Messages::BatchMessagesStatusRequest,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The message IDs to update the status of.
+        sig { returns(T::Array[String]) }
+        attr_accessor :message_ids
+
+        # Request to update the status of multiple messages in batch.
+        sig { params(message_ids: T::Array[String]).returns(T.attached_class) }
+        def self.new(
+          # The message IDs to update the status of.
+          message_ids:
+        )
+        end
+
+        sig { override.returns({ message_ids: T::Array[String] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/messages/batch_unarchive_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Messages
-      class BatchUnarchiveParams < Knockapi::Internal::Type::BaseModel
+      class BatchUnarchiveParams < Knockapi::Models::Messages::BatchMessagesStatusRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -15,31 +15,15 @@ module Knockapi
             )
           end
 
-        # The message IDs to update the status of.
-        sig { returns(T::Array[String]) }
-        attr_accessor :message_ids
-
         sig do
-          params(
-            message_ids: T::Array[String],
-            request_options: Knockapi::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: Knockapi::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The message IDs to update the status of.
-          message_ids:,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            {
-              message_ids: T::Array[String],
-              request_options: Knockapi::RequestOptions
-            }
-          )
-        end
+        sig { override.returns({ request_options: Knockapi::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/knockapi/models/preference_set_commercial_subscribed_setting.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class PreferenceSetCommercialSubscribedSetting < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::PreferenceSetCommercialSubscribedSetting,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      # A list of conditions to apply to the commercial subscribed preference.
+      sig { returns(T::Array[Knockapi::Condition]) }
+      attr_accessor :conditions
+
+      # A set of settings for the commercial subscribed preference. Currently, this can
+      # only be a list of conditions to apply.
+      sig do
+        params(conditions: T::Array[Knockapi::Condition::OrHash]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # A list of conditions to apply to the commercial subscribed preference.
+        conditions:
+      )
+      end
+
+      sig { override.returns({ conditions: T::Array[Knockapi::Condition] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/recipients/preference_set.rbi

@@ -58,8 +58,16 @@ module Knockapi
         attr_accessor :channels
 
         # Whether the recipient is subscribed to commercial communications. When false,
-        # the recipient will not receive commercial workflow notifications.
-        sig { returns(T.nilable(T::Boolean)) }
+        # the recipient will not receive commercial workflow notifications. Can also be
+        # set to a settings object with conditions that are evaluated at notification send
+        # time.
+        sig do
+          returns(
+            T.nilable(
+              Knockapi::Recipients::PreferenceSet::CommercialSubscribed::Variants
+            )
+          )
+        end
         attr_accessor :commercial_subscribed
 
         # An object where the key is the workflow key and the values are the preference
@@ -105,7 +113,13 @@ module Knockapi
                   )
                 ]
               ),
-            commercial_subscribed: T.nilable(T::Boolean),
+            commercial_subscribed:
+              T.nilable(
+                T.any(
+                  T::Boolean,
+                  Knockapi::PreferenceSetCommercialSubscribedSetting::OrHash
+                )
+              ),
             workflows:
               T.nilable(
                 T::Hash[
@@ -129,7 +143,9 @@ module Knockapi
           # Channel preferences.
           channels: nil,
           # Whether the recipient is subscribed to commercial communications. When false,
-          # the recipient will not receive commercial workflow notifications.
+          # the recipient will not receive commercial workflow notifications. Can also be
+          # set to a settings object with conditions that are evaluated at notification send
+          # time.
           commercial_subscribed: nil,
           # An object where the key is the workflow key and the values are the preference
           # settings for that workflow.
@@ -157,7 +173,10 @@ module Knockapi
                     Knockapi::Recipients::PreferenceSet::Channel::Variants
                   ]
                 ),
-              commercial_subscribed: T.nilable(T::Boolean),
+              commercial_subscribed:
+                T.nilable(
+                  Knockapi::Recipients::PreferenceSet::CommercialSubscribed::Variants
+                ),
               workflows:
                 T.nilable(
                   T::Hash[
@@ -333,6 +352,32 @@ module Knockapi
           end
         end
 
+        # Whether the recipient is subscribed to commercial communications. When false,
+        # the recipient will not receive commercial workflow notifications. Can also be
+        # set to a settings object with conditions that are evaluated at notification send
+        # time.
+        module CommercialSubscribed
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::PreferenceSetCommercialSubscribedSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSet::CommercialSubscribed::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # Workflow or category preferences within a preference set
         module Workflow
           extend Knockapi::Internal::Type::Union

data/rbi/knockapi/models/recipients/preference_set_request.rbi

@@ -79,8 +79,19 @@ module Knockapi
         attr_accessor :channels
 
         # Whether the recipient is subscribed to commercial communications. When false,
-        # the recipient will not receive commercial workflow notifications.
-        sig { returns(T.nilable(T::Boolean)) }
+        # the recipient will not receive commercial workflow notifications. Can also be
+        # set to a settings object with conditions that are evaluated at notification send
+        # time.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Boolean,
+                Knockapi::PreferenceSetCommercialSubscribedSetting
+              )
+            )
+          )
+        end
         attr_accessor :commercial_subscribed
 
         # An object where the key is the workflow key and the values are the preference
@@ -129,7 +140,13 @@ module Knockapi
                   )
                 ]
               ),
-            commercial_subscribed: T.nilable(T::Boolean),
+            commercial_subscribed:
+              T.nilable(
+                T.any(
+                  T::Boolean,
+                  Knockapi::PreferenceSetCommercialSubscribedSetting::OrHash
+                )
+              ),
             workflows:
               T.nilable(
                 T::Hash[
@@ -154,7 +171,9 @@ module Knockapi
           # Channel preferences.
           channels: nil,
           # Whether the recipient is subscribed to commercial communications. When false,
-          # the recipient will not receive commercial workflow notifications.
+          # the recipient will not receive commercial workflow notifications. Can also be
+          # set to a settings object with conditions that are evaluated at notification send
+          # time.
           commercial_subscribed: nil,
           # An object where the key is the workflow key and the values are the preference
           # settings for that workflow.
@@ -189,7 +208,13 @@ module Knockapi
                     )
                   ]
                 ),
-              commercial_subscribed: T.nilable(T::Boolean),
+              commercial_subscribed:
+                T.nilable(
+                  T.any(
+                    T::Boolean,
+                    Knockapi::PreferenceSetCommercialSubscribedSetting
+                  )
+                ),
               workflows:
                 T.nilable(
                   T::Hash[
@@ -414,6 +439,32 @@ module Knockapi
           end
         end
 
+        # Whether the recipient is subscribed to commercial communications. When false,
+        # the recipient will not receive commercial workflow notifications. Can also be
+        # set to a settings object with conditions that are evaluated at notification send
+        # time.
+        module CommercialSubscribed
+          extend Knockapi::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::PreferenceSetCommercialSubscribedSetting
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Knockapi::Recipients::PreferenceSetRequest::CommercialSubscribed::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # Workflow or category preferences within a preference set
         module Workflow
           extend Knockapi::Internal::Type::Union

data/rbi/knockapi/models/recipients/slack_channel_data.rbi

@@ -107,6 +107,10 @@ module Knockapi
             sig { returns(T.nilable(String)) }
             attr_accessor :channel_id
 
+            # Slack channel name.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :channel_name
+
             # A Slack user ID from the Slack provider.
             sig { returns(T.nilable(String)) }
             attr_accessor :user_id
@@ -116,6 +120,7 @@ module Knockapi
               params(
                 access_token: T.nilable(String),
                 channel_id: T.nilable(String),
+                channel_name: T.nilable(String),
                 user_id: T.nilable(String)
               ).returns(T.attached_class)
             end
@@ -124,6 +129,8 @@ module Knockapi
               access_token: nil,
               # A Slack channel ID from the Slack provider.
               channel_id: nil,
+              # Slack channel name.
+              channel_name: nil,
               # A Slack user ID from the Slack provider.
               user_id: nil
             )
@@ -134,6 +141,7 @@ module Knockapi
                 {
                   access_token: T.nilable(String),
                   channel_id: T.nilable(String),
+                  channel_name: T.nilable(String),
                   user_id: T.nilable(String)
                 }
               )

data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi

@@ -129,8 +129,19 @@ module Knockapi
           attr_accessor :channels
 
           # Whether the recipient is subscribed to commercial communications. When false,
-          # the recipient will not receive commercial workflow notifications.
-          sig { returns(T.nilable(T::Boolean)) }
+          # the recipient will not receive commercial workflow notifications. Can also be
+          # set to a settings object with conditions that are evaluated at notification send
+          # time.
+          sig do
+            returns(
+              T.nilable(
+                T.any(
+                  T::Boolean,
+                  Knockapi::PreferenceSetCommercialSubscribedSetting
+                )
+              )
+            )
+          end
           attr_accessor :commercial_subscribed
 
           # An object where the key is the workflow key and the values are the preference
@@ -179,7 +190,13 @@ module Knockapi
                     )
                   ]
                 ),
-              commercial_subscribed: T.nilable(T::Boolean),
+              commercial_subscribed:
+                T.nilable(
+                  T.any(
+                    T::Boolean,
+                    Knockapi::PreferenceSetCommercialSubscribedSetting::OrHash
+                  )
+                ),
               workflows:
                 T.nilable(
                   T::Hash[
@@ -203,7 +220,9 @@ module Knockapi
             # Channel preferences.
             channels: nil,
             # Whether the recipient is subscribed to commercial communications. When false,
-            # the recipient will not receive commercial workflow notifications.
+            # the recipient will not receive commercial workflow notifications. Can also be
+            # set to a settings object with conditions that are evaluated at notification send
+            # time.
             commercial_subscribed: nil,
             # An object where the key is the workflow key and the values are the preference
             # settings for that workflow.
@@ -237,7 +256,13 @@ module Knockapi
                       )
                     ]
                   ),
-                commercial_subscribed: T.nilable(T::Boolean),
+                commercial_subscribed:
+                  T.nilable(
+                    T.any(
+                      T::Boolean,
+                      Knockapi::PreferenceSetCommercialSubscribedSetting
+                    )
+                  ),
                 workflows:
                   T.nilable(
                     T::Hash[
@@ -428,6 +453,32 @@ module Knockapi
             end
           end
 
+          # Whether the recipient is subscribed to commercial communications. When false,
+          # the recipient will not receive commercial workflow notifications. Can also be
+          # set to a settings object with conditions that are evaluated at notification send
+          # time.
+          module CommercialSubscribed
+            extend Knockapi::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  T::Boolean,
+                  Knockapi::PreferenceSetCommercialSubscribedSetting
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::CommercialSubscribed::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
           # Workflow or category preferences within a preference set
           module Workflow
             extend Knockapi::Internal::Type::Union