knockapi 1.35.0 → 1.36.0

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

@@ -15,13 +15,15 @@ module Knockapi
             )
           end
 
-        # A request to set a preference set for a recipient.
-        sig { returns(Knockapi::Recipients::PreferenceSetRequest) }
+        # A preference set to apply in a bulk operation. Always replaces existing
+        # preferences for the specified set.
+        sig { returns(Knockapi::Users::BulkSetPreferencesParams::Preferences) }
         attr_reader :preferences
 
         sig do
           params(
-            preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash
+            preferences:
+              Knockapi::Users::BulkSetPreferencesParams::Preferences::OrHash
           ).void
         end
         attr_writer :preferences
@@ -32,13 +34,15 @@ module Knockapi
 
         sig do
           params(
-            preferences: Knockapi::Recipients::PreferenceSetRequest::OrHash,
+            preferences:
+              Knockapi::Users::BulkSetPreferencesParams::Preferences::OrHash,
             user_ids: T::Array[String],
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # A request to set a preference set for a recipient.
+          # A preference set to apply in a bulk operation. Always replaces existing
+          # preferences for the specified set.
           preferences:,
           # A list of user IDs.
           user_ids:,
@@ -49,7 +53,8 @@ module Knockapi
         sig do
           override.returns(
             {
-              preferences: Knockapi::Recipients::PreferenceSetRequest,
+              preferences:
+                Knockapi::Users::BulkSetPreferencesParams::Preferences,
               user_ids: T::Array[String],
               request_options: Knockapi::RequestOptions
             }
@@ -57,6 +62,522 @@ module Knockapi
         end
         def to_hash
         end
+
+        class Preferences < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Users::BulkSetPreferencesParams::Preferences,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # Identifier for the preference set to update. Can be `default` or a tenant ID.
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # An object where the key is the category and the values are the preference
+          # settings for that category.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject
+                  )
+                ]
+              )
+            )
+          end
+          attr_accessor :categories
+
+          # Channel type preferences.
+          sig do
+            returns(T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes))
+          end
+          attr_reader :channel_types
+
+          sig do
+            params(
+              channel_types:
+                T.nilable(
+                  Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                )
+            ).void
+          end
+          attr_writer :channel_types
+
+          # Channel preferences.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Recipients::PreferenceSetChannelSetting
+                  )
+                ]
+              )
+            )
+          end
+          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)) }
+          attr_accessor :commercial_subscribed
+
+          # An object where the key is the workflow key and the values are the preference
+          # settings for that workflow.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    T::Boolean,
+                    Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject
+                  )
+                ]
+              )
+            )
+          end
+          attr_accessor :workflows
+
+          # A preference set to apply in a bulk operation. Always replaces existing
+          # preferences for the specified set.
+          sig do
+            params(
+              id: String,
+              categories:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject::OrHash
+                    )
+                  ]
+                ),
+              channel_types:
+                T.nilable(
+                  Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                ),
+              channels:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
+                    )
+                  ]
+                ),
+              commercial_subscribed: T.nilable(T::Boolean),
+              workflows:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject::OrHash
+                    )
+                  ]
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier for the preference set to update. Can be `default` or a tenant ID.
+            id: nil,
+            # An object where the key is the category and the values are the preference
+            # settings for that category.
+            categories: nil,
+            # Channel type preferences.
+            channel_types: nil,
+            # Channel preferences.
+            channels: nil,
+            # Whether the recipient is subscribed to commercial communications. When false,
+            # the recipient will not receive commercial workflow notifications.
+            commercial_subscribed: nil,
+            # An object where the key is the workflow key and the values are the preference
+            # settings for that workflow.
+            workflows: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                categories:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject
+                      )
+                    ]
+                  ),
+                channel_types:
+                  T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes),
+                channels:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Recipients::PreferenceSetChannelSetting
+                      )
+                    ]
+                  ),
+                commercial_subscribed: T.nilable(T::Boolean),
+                workflows:
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject
+                      )
+                    ]
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Workflow or category preferences within a preference set
+          module Category
+            extend Knockapi::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  T::Boolean,
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject
+                )
+              end
+
+            class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject,
+                    Knockapi::Internal::AnyHash
+                  )
+                end
+
+              # Channel type preferences.
+              sig do
+                returns(
+                  T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+                )
+              end
+              attr_reader :channel_types
+
+              sig do
+                params(
+                  channel_types:
+                    T.nilable(
+                      Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                    )
+                ).void
+              end
+              attr_writer :channel_types
+
+              # Channel preferences.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Recipients::PreferenceSetChannelSetting
+                      )
+                    ]
+                  )
+                )
+              end
+              attr_accessor :channels
+
+              # A list of conditions to apply to a channel type.
+              sig { returns(T.nilable(T::Array[Knockapi::Condition])) }
+              attr_accessor :conditions
+
+              # The settings object for a workflow or category, where you can specify channel
+              # types or conditions.
+              sig do
+                params(
+                  channel_types:
+                    T.nilable(
+                      Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                    ),
+                  channels:
+                    T.nilable(
+                      T::Hash[
+                        Symbol,
+                        T.any(
+                          T::Boolean,
+                          Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
+                        )
+                      ]
+                    ),
+                  conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Channel type preferences.
+                channel_types: nil,
+                # Channel preferences.
+                channels: nil,
+                # A list of conditions to apply to a channel type.
+                conditions: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    channel_types:
+                      T.nilable(
+                        Knockapi::Recipients::PreferenceSetChannelTypes
+                      ),
+                    channels:
+                      T.nilable(
+                        T::Hash[
+                          Symbol,
+                          T.any(
+                            T::Boolean,
+                            Knockapi::Recipients::PreferenceSetChannelSetting
+                          )
+                        ]
+                      ),
+                    conditions: T.nilable(T::Array[Knockapi::Condition])
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Whether the specific channel (by channel_id) is enabled for the preference set,
+              # or a settings object with conditions.
+              module Channel
+                extend Knockapi::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Recipients::PreferenceSetChannelSetting
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::Category::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          # Whether the specific channel (by channel_id) is enabled for the preference set,
+          # or a settings object with conditions.
+          module Channel
+            extend Knockapi::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  T::Boolean,
+                  Knockapi::Recipients::PreferenceSetChannelSetting
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::Channel::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          # Workflow or category preferences within a preference set
+          module Workflow
+            extend Knockapi::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  T::Boolean,
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject
+                )
+              end
+
+            class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject,
+                    Knockapi::Internal::AnyHash
+                  )
+                end
+
+              # Channel type preferences.
+              sig do
+                returns(
+                  T.nilable(Knockapi::Recipients::PreferenceSetChannelTypes)
+                )
+              end
+              attr_reader :channel_types
+
+              sig do
+                params(
+                  channel_types:
+                    T.nilable(
+                      Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                    )
+                ).void
+              end
+              attr_writer :channel_types
+
+              # Channel preferences.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Hash[
+                      Symbol,
+                      T.any(
+                        T::Boolean,
+                        Knockapi::Recipients::PreferenceSetChannelSetting
+                      )
+                    ]
+                  )
+                )
+              end
+              attr_accessor :channels
+
+              # A list of conditions to apply to a channel type.
+              sig { returns(T.nilable(T::Array[Knockapi::Condition])) }
+              attr_accessor :conditions
+
+              # The settings object for a workflow or category, where you can specify channel
+              # types or conditions.
+              sig do
+                params(
+                  channel_types:
+                    T.nilable(
+                      Knockapi::Recipients::PreferenceSetChannelTypes::OrHash
+                    ),
+                  channels:
+                    T.nilable(
+                      T::Hash[
+                        Symbol,
+                        T.any(
+                          T::Boolean,
+                          Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
+                        )
+                      ]
+                    ),
+                  conditions: T.nilable(T::Array[Knockapi::Condition::OrHash])
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Channel type preferences.
+                channel_types: nil,
+                # Channel preferences.
+                channels: nil,
+                # A list of conditions to apply to a channel type.
+                conditions: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    channel_types:
+                      T.nilable(
+                        Knockapi::Recipients::PreferenceSetChannelTypes
+                      ),
+                    channels:
+                      T.nilable(
+                        T::Hash[
+                          Symbol,
+                          T.any(
+                            T::Boolean,
+                            Knockapi::Recipients::PreferenceSetChannelSetting
+                          )
+                        ]
+                      ),
+                    conditions: T.nilable(T::Array[Knockapi::Condition])
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Whether the specific channel (by channel_id) is enabled for the preference set,
+              # or a settings object with conditions.
+              module Channel
+                extend Knockapi::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      T::Boolean,
+                      Knockapi::Recipients::PreferenceSetChannelSetting
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
       end
     end
   end

data/rbi/knockapi/models/users/guide_get_channel_response.rbi

@@ -184,6 +184,13 @@ module Knockapi
           sig { params(channel_id: String).void }
           attr_writer :channel_id
 
+          # URL to this guide in the Knock dashboard
+          sig { returns(T.nilable(String)) }
+          attr_reader :dashboard_url
+
+          sig { params(dashboard_url: String).void }
+          attr_writer :dashboard_url
+
           sig { returns(T.nilable(Time)) }
           attr_reader :inserted_at
 
@@ -252,6 +259,7 @@ module Knockapi
               active: T::Boolean,
               bypass_global_group_limit: T::Boolean,
               channel_id: String,
+              dashboard_url: String,
               inserted_at: Time,
               key: String,
               semver: String,
@@ -278,6 +286,8 @@ module Knockapi
             active: nil,
             bypass_global_group_limit: nil,
             channel_id: nil,
+            # URL to this guide in the Knock dashboard
+            dashboard_url: nil,
             inserted_at: nil,
             # The key of the guide.
             key: nil,
@@ -305,6 +315,7 @@ module Knockapi
                 active: T::Boolean,
                 bypass_global_group_limit: T::Boolean,
                 channel_id: String,
+                dashboard_url: String,
                 inserted_at: Time,
                 key: String,
                 semver: String,

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -14,11 +14,11 @@ module Knockapi
       sig { returns(String) }
       attr_accessor :key
 
-      # An optional key that is used to reference a specific workflow trigger request
-      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-      # request. Must be provided while triggering a workflow in order to enable
-      # subsequent cancellation. Should be unique across trigger requests to avoid
-      # unintentional cancellations.
+      # A key that is used to reference a specific workflow trigger request when issuing
+      # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+      # be provided while triggering a workflow in order to enable subsequent
+      # cancellation. Should be unique across trigger requests to avoid unintentional
+      # cancellations.
       sig { returns(String) }
       attr_accessor :cancellation_key
 
@@ -53,11 +53,11 @@ module Knockapi
       end
       def self.new(
         key:,
-        # An optional key that is used to reference a specific workflow trigger request
-        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
-        # request. Must be provided while triggering a workflow in order to enable
-        # subsequent cancellation. Should be unique across trigger requests to avoid
-        # unintentional cancellations.
+        # A key that is used to reference a specific workflow trigger request when issuing
+        # a [workflow cancellation](/send-notifications/canceling-workflows) request. Must
+        # be provided while triggering a workflow in order to enable subsequent
+        # cancellation. Should be unique across trigger requests to avoid unintentional
+        # cancellations.
         cancellation_key:,
         # A list of recipients to cancel the notification for. If omitted, cancels for all
         # recipients associated with the cancellation key.