knockapi 1.38.0 → 1.40.0

data/sig/knockapi/models/recipients/slack_channel_data.rbs

@@ -30,24 +30,33 @@ module Knockapi
           extend Knockapi::Internal::Type::Union
 
           type slack_token_connection =
-            { access_token: String?, channel_id: String?, user_id: String? }
+            {
+              access_token: String?,
+              channel_id: String?,
+              channel_name: String?,
+              user_id: String?
+            }
 
           class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
             attr_accessor access_token: String?
 
             attr_accessor channel_id: String?
 
+            attr_accessor channel_name: String?
+
             attr_accessor user_id: String?
 
             def initialize: (
               ?access_token: String?,
               ?channel_id: String?,
+              ?channel_name: String?,
               ?user_id: String?
             ) -> void
 
             def to_hash: -> {
               access_token: String?,
               channel_id: String?,
+              channel_name: String?,
               user_id: String?
             }
           end

data/sig/knockapi/models/users/bulk_set_preferences_params.rbs

@@ -34,7 +34,7 @@ module Knockapi
             categories: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::category]?,
             channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
             channels: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::channel]?,
-            commercial_subscribed: bool?,
+            commercial_subscribed: Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::commercial_subscribed?,
             workflows: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::workflow]?
           }
 
@@ -49,7 +49,7 @@ module Knockapi
 
           attr_accessor channels: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::channel]?
 
-          attr_accessor commercial_subscribed: bool?
+          attr_accessor commercial_subscribed: Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::commercial_subscribed?
 
           attr_accessor workflows: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::workflow]?
 
@@ -58,7 +58,7 @@ module Knockapi
             ?categories: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::category]?,
             ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
             ?channels: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::channel]?,
-            ?commercial_subscribed: bool?,
+            ?commercial_subscribed: Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::commercial_subscribed?,
             ?workflows: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::workflow]?
           ) -> void
 
@@ -67,7 +67,7 @@ module Knockapi
             categories: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::category]?,
             channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
             channels: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::channel]?,
-            commercial_subscribed: bool?,
+            commercial_subscribed: Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::commercial_subscribed?,
             workflows: ::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::workflow]?
           }
 
@@ -126,6 +126,15 @@ module Knockapi
             def self?.variants: -> ::Array[Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::channel]
           end
 
+          type commercial_subscribed =
+            bool | Knockapi::PreferenceSetCommercialSubscribedSetting
+
+          module CommercialSubscribed
+            extend Knockapi::Internal::Type::Union
+
+            def self?.variants: -> ::Array[Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::commercial_subscribed]
+          end
+
           type workflow =
             bool
             | Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject

data/sig/knockapi/models/users/feed_list_items_response.rbs

@@ -103,110 +103,12 @@ module Knockapi
         }
 
         type block =
-          Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock
-          | Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
+          Knockapi::MessageInAppFeedContentBlock
+          | Knockapi::MessageInAppFeedButtonSetBlock
 
         module Block
           extend Knockapi::Internal::Type::Union
 
-          type message_in_app_feed_content_block =
-            {
-              content: String,
-              name: String,
-              rendered: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
-            }
-
-          class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
-            attr_accessor content: String
-
-            attr_accessor name: String
-
-            attr_accessor rendered: String
-
-            attr_accessor type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
-
-            def initialize: (
-              content: String,
-              name: String,
-              rendered: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
-            ) -> void
-
-            def to_hash: -> {
-              content: String,
-              name: String,
-              rendered: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_
-            }
-
-            type type_ = :markdown | :text
-
-            module Type
-              extend Knockapi::Internal::Type::Enum
-
-              MARKDOWN: :markdown
-              TEXT: :text
-
-              def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::type_]
-            end
-          end
-
-          type message_in_app_feed_button_set_block =
-            {
-              buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button],
-              name: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
-            }
-
-          class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
-            attr_accessor buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button]
-
-            attr_accessor name: String
-
-            attr_accessor type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
-
-            def initialize: (
-              buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button],
-              name: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
-            ) -> void
-
-            def to_hash: -> {
-              buttons: ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button],
-              name: String,
-              type: Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_
-            }
-
-            type button = { action: String, label: String, name: String }
-
-            class Button < Knockapi::Internal::Type::BaseModel
-              attr_accessor action: String
-
-              attr_accessor label: String
-
-              attr_accessor name: String
-
-              def initialize: (
-                action: String,
-                label: String,
-                name: String
-              ) -> void
-
-              def to_hash: -> { action: String, label: String, name: String }
-            end
-
-            type type_ = :button_set
-
-            module Type
-              extend Knockapi::Internal::Type::Enum
-
-              BUTTON_SET: :button_set
-
-              def self?.values: -> ::Array[Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::type_]
-            end
-          end
-
           def self?.variants: -> ::Array[Knockapi::Models::Users::FeedListItemsResponse::block]
         end
 

data/sig/knockapi/models/users/{guide_mark_message_as_seen_response.rbs → guide_action_response.rbs}

@@ -1,9 +1,9 @@
 module Knockapi
   module Models
     module Users
-      type guide_mark_message_as_seen_response = { status: String }
+      type guide_action_response = { status: String }
 
-      class GuideMarkMessageAsSeenResponse < Knockapi::Internal::Type::BaseModel
+      class GuideActionResponse < Knockapi::Internal::Type::BaseModel
         attr_accessor status: String
 
         def initialize: (status: String) -> void

data/sig/knockapi/models/users/guide_archived_request.rbs

@@ -0,0 +1,58 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_archived_request =
+        {
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          is_final: bool,
+          tenant: String,
+          unthrottled: bool
+        }
+
+      class GuideArchivedRequest < Knockapi::Internal::Type::BaseModel
+        attr_accessor channel_id: String
+
+        attr_accessor guide_id: String
+
+        attr_accessor guide_key: String
+
+        attr_accessor guide_step_ref: String
+
+        attr_reader is_final: bool?
+
+        def is_final=: (bool) -> bool
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        attr_reader unthrottled: bool?
+
+        def unthrottled=: (bool) -> bool
+
+        def initialize: (
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?is_final: bool,
+          ?tenant: String,
+          ?unthrottled: bool
+        ) -> void
+
+        def to_hash: -> {
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          is_final: bool,
+          tenant: String,
+          unthrottled: bool
+        }
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_interacted_request.rbs

@@ -0,0 +1,51 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_interacted_request =
+        {
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          metadata: ::Hash[Symbol, top],
+          tenant: String
+        }
+
+      class GuideInteractedRequest < Knockapi::Internal::Type::BaseModel
+        attr_accessor channel_id: String
+
+        attr_accessor guide_id: String
+
+        attr_accessor guide_key: String
+
+        attr_accessor guide_step_ref: String
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        def initialize: (
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?metadata: ::Hash[Symbol, top],
+          ?tenant: String
+        ) -> void
+
+        def to_hash: -> {
+          channel_id: String,
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          metadata: ::Hash[Symbol, top],
+          tenant: String
+        }
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs

@@ -2,82 +2,23 @@ module Knockapi
   module Models
     module Users
       type guide_mark_message_as_archived_params =
-        {
-          user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?
-        }
-        & Knockapi::Internal::Type::request_parameters
+        { user_id: String } & Knockapi::Internal::Type::request_parameters
 
-      class GuideMarkMessageAsArchivedParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsArchivedParams < Knockapi::Models::Users::GuideArchivedRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        attr_accessor user_id: String
-
-        attr_accessor message_id: String
-
-        attr_accessor channel_id: String
-
-        attr_accessor guide_id: String
-
-        attr_accessor guide_key: String
-
-        attr_accessor guide_step_ref: String
-
-        attr_reader content: ::Hash[Symbol, top]?
-
-        def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader data: ::Hash[Symbol, top]?
-
-        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader is_final: bool?
-
-        def is_final=: (bool) -> bool
-
-        attr_reader metadata: ::Hash[Symbol, top]?
-
-        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+        def user_id: -> String
 
-        attr_accessor tenant: String?
+        def user_id=: (String _) -> String
 
         def initialize: (
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          ?content: ::Hash[Symbol, top],
-          ?data: ::Hash[Symbol, top],
-          ?is_final: bool,
-          ?metadata: ::Hash[Symbol, top],
-          ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
 
         def to_hash: -> {
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?,
           request_options: Knockapi::RequestOptions
         }
       end

data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs

@@ -2,82 +2,23 @@ module Knockapi
   module Models
     module Users
       type guide_mark_message_as_interacted_params =
-        {
-          user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?
-        }
-        & Knockapi::Internal::Type::request_parameters
+        { user_id: String } & Knockapi::Internal::Type::request_parameters
 
-      class GuideMarkMessageAsInteractedParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsInteractedParams < Knockapi::Models::Users::GuideInteractedRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        attr_accessor user_id: String
-
-        attr_accessor message_id: String
-
-        attr_accessor channel_id: String
-
-        attr_accessor guide_id: String
-
-        attr_accessor guide_key: String
-
-        attr_accessor guide_step_ref: String
-
-        attr_reader content: ::Hash[Symbol, top]?
-
-        def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader data: ::Hash[Symbol, top]?
-
-        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader is_final: bool?
-
-        def is_final=: (bool) -> bool
-
-        attr_reader metadata: ::Hash[Symbol, top]?
-
-        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+        def user_id: -> String
 
-        attr_accessor tenant: String?
+        def user_id=: (String _) -> String
 
         def initialize: (
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          ?content: ::Hash[Symbol, top],
-          ?data: ::Hash[Symbol, top],
-          ?is_final: bool,
-          ?metadata: ::Hash[Symbol, top],
-          ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
 
         def to_hash: -> {
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?,
           request_options: Knockapi::RequestOptions
         }
       end

data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs

@@ -2,82 +2,23 @@ module Knockapi
   module Models
     module Users
       type guide_mark_message_as_seen_params =
-        {
-          user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?
-        }
-        & Knockapi::Internal::Type::request_parameters
+        { user_id: String } & Knockapi::Internal::Type::request_parameters
 
-      class GuideMarkMessageAsSeenParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsSeenParams < Knockapi::Models::Users::GuideSeenRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        attr_accessor user_id: String
-
-        attr_accessor message_id: String
-
-        attr_accessor channel_id: String
-
-        attr_accessor guide_id: String
-
-        attr_accessor guide_key: String
-
-        attr_accessor guide_step_ref: String
-
-        attr_reader content: ::Hash[Symbol, top]?
-
-        def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader data: ::Hash[Symbol, top]?
-
-        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
-
-        attr_reader is_final: bool?
-
-        def is_final=: (bool) -> bool
-
-        attr_reader metadata: ::Hash[Symbol, top]?
-
-        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+        def user_id: -> String
 
-        attr_accessor tenant: String?
+        def user_id=: (String _) -> String
 
         def initialize: (
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          ?content: ::Hash[Symbol, top],
-          ?data: ::Hash[Symbol, top],
-          ?is_final: bool,
-          ?metadata: ::Hash[Symbol, top],
-          ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
 
         def to_hash: -> {
           user_id: String,
-          message_id: String,
-          channel_id: String,
-          guide_id: String,
-          guide_key: String,
-          guide_step_ref: String,
-          content: ::Hash[Symbol, top],
-          data: ::Hash[Symbol, top],
-          is_final: bool,
-          metadata: ::Hash[Symbol, top],
-          tenant: String?,
           request_options: Knockapi::RequestOptions
         }
       end

data/sig/knockapi/models/users/guide_reset_guide_engagements_params.rbs

@@ -0,0 +1,36 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_reset_guide_engagements_params =
+        { user_id: String, guide_key: String, tenant: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class GuideResetGuideEngagementsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor guide_key: String
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        def initialize: (
+          user_id: String,
+          guide_key: String,
+          ?tenant: String,
+          ?request_options: Knockapi::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          guide_key: String,
+          tenant: String,
+          request_options: Knockapi::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/knockapi/models/users/guide_seen_request.rbs

@@ -0,0 +1,56 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_seen_request =
+        {
+          channel_id: String,
+          content: ::Hash[Symbol, top],
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          data: ::Hash[Symbol, top],
+          tenant: String
+        }
+
+      class GuideSeenRequest < Knockapi::Internal::Type::BaseModel
+        attr_accessor channel_id: String
+
+        attr_accessor content: ::Hash[Symbol, top]
+
+        attr_accessor guide_id: String
+
+        attr_accessor guide_key: String
+
+        attr_accessor guide_step_ref: String
+
+        attr_reader data: ::Hash[Symbol, top]?
+
+        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader tenant: String?
+
+        def tenant=: (String) -> String
+
+        def initialize: (
+          channel_id: String,
+          content: ::Hash[Symbol, top],
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          ?data: ::Hash[Symbol, top],
+          ?tenant: String
+        ) -> void
+
+        def to_hash: -> {
+          channel_id: String,
+          content: ::Hash[Symbol, top],
+          guide_id: String,
+          guide_key: String,
+          guide_step_ref: String,
+          data: ::Hash[Symbol, top],
+          tenant: String
+        }
+      end
+    end
+  end
+end