knockapi 1.38.0 → 1.40.0

data/rbi/knockapi/models/users/feed_list_items_response.rbi

@@ -109,8 +109,8 @@ module Knockapi
             blocks:
               T::Array[
                 T.any(
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::OrHash,
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::OrHash
+                  Knockapi::MessageInAppFeedContentBlock::OrHash,
+                  Knockapi::MessageInAppFeedButtonSetBlock::OrHash
                 )
               ],
             data: T.nilable(T::Hash[Symbol, T.anything]),
@@ -206,258 +206,11 @@ module Knockapi
           Variants =
             T.type_alias do
               T.any(
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock,
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
+                Knockapi::MessageInAppFeedContentBlock,
+                Knockapi::MessageInAppFeedButtonSetBlock
               )
             end
 
-          class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock,
-                  Knockapi::Internal::AnyHash
-                )
-              end
-
-            # The content of the block in a message in an app feed.
-            sig { returns(String) }
-            attr_accessor :content
-
-            # The name of the block in a message in an app feed.
-            sig { returns(String) }
-            attr_accessor :name
-
-            # The rendered HTML version of the content.
-            sig { returns(String) }
-            attr_accessor :rendered
-
-            # The type of block in a message in an app feed.
-            sig do
-              returns(
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
-              )
-            end
-            attr_accessor :type
-
-            # A block in a message in an app feed.
-            sig do
-              params(
-                content: String,
-                name: String,
-                rendered: String,
-                type:
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::OrSymbol
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # The content of the block in a message in an app feed.
-              content:,
-              # The name of the block in a message in an app feed.
-              name:,
-              # The rendered HTML version of the content.
-              rendered:,
-              # The type of block in a message in an app feed.
-              type:
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  content: String,
-                  name: String,
-                  rendered: String,
-                  type:
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
-                }
-              )
-            end
-            def to_hash
-            end
-
-            # The type of block in a message in an app feed.
-            module Type
-              extend Knockapi::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              MARKDOWN =
-                T.let(
-                  :markdown,
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
-                )
-              TEXT =
-                T.let(
-                  :text,
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-
-          class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock,
-                  Knockapi::Internal::AnyHash
-                )
-              end
-
-            # A list of buttons in an in app feed message.
-            sig do
-              returns(
-                T::Array[
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button
-                ]
-              )
-            end
-            attr_accessor :buttons
-
-            # The name of the button set in a message in an app feed.
-            sig { returns(String) }
-            attr_accessor :name
-
-            # The type of block in a message in an app feed.
-            sig do
-              returns(
-                Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
-              )
-            end
-            attr_accessor :type
-
-            # A button set block in a message in an app feed.
-            sig do
-              params(
-                buttons:
-                  T::Array[
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button::OrHash
-                  ],
-                name: String,
-                type:
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type::OrSymbol
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # A list of buttons in an in app feed message.
-              buttons:,
-              # The name of the button set in a message in an app feed.
-              name:,
-              # The type of block in a message in an app feed.
-              type:
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  buttons:
-                    T::Array[
-                      Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button
-                    ],
-                  name: String,
-                  type:
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class Button < Knockapi::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Button,
-                    Knockapi::Internal::AnyHash
-                  )
-                end
-
-              # The action to take when the button is clicked.
-              sig { returns(String) }
-              attr_accessor :action
-
-              # The label of the button.
-              sig { returns(String) }
-              attr_accessor :label
-
-              # The name of the button.
-              sig { returns(String) }
-              attr_accessor :name
-
-              # A button in an in app feed message.
-              sig do
-                params(action: String, label: String, name: String).returns(
-                  T.attached_class
-                )
-              end
-              def self.new(
-                # The action to take when the button is clicked.
-                action:,
-                # The label of the button.
-                label:,
-                # The name of the button.
-                name:
-              )
-              end
-
-              sig do
-                override.returns(
-                  { action: String, label: String, name: String }
-                )
-              end
-              def to_hash
-              end
-            end
-
-            # The type of block in a message in an app feed.
-            module Type
-              extend Knockapi::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              BUTTON_SET =
-                T.let(
-                  :button_set,
-                  Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-
           sig do
             override.returns(
               T::Array[

data/rbi/knockapi/models/users/{guide_mark_message_as_seen_response.rbi → guide_action_response.rbi}

@@ -3,11 +3,11 @@
 module Knockapi
   module Models
     module Users
-      class GuideMarkMessageAsSeenResponse < Knockapi::Internal::Type::BaseModel
+      class GuideActionResponse < Knockapi::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Knockapi::Models::Users::GuideMarkMessageAsSeenResponse,
+              Knockapi::Users::GuideActionResponse,
               Knockapi::Internal::AnyHash
             )
           end

data/rbi/knockapi/models/users/guide_archived_request.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideArchivedRequest < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideArchivedRequest,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The unique identifier for the guide.
+        sig { returns(String) }
+        attr_accessor :guide_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The step reference of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_step_ref
+
+        # Whether the guide is final.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_final
+
+        sig { params(is_final: T::Boolean).void }
+        attr_writer :is_final
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tenant
+
+        sig { params(tenant: String).void }
+        attr_writer :tenant
+
+        # Whether the guide bypasses its guide group's throttle settings. When true,
+        # archiving the guide does not open a new throttle window.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :unthrottled
+
+        sig { params(unthrottled: T::Boolean).void }
+        attr_writer :unthrottled
+
+        # A request to mark a guide as archived.
+        sig do
+          params(
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            is_final: T::Boolean,
+            tenant: String,
+            unthrottled: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # Whether the guide is final.
+          is_final: nil,
+          # The tenant ID of the guide.
+          tenant: nil,
+          # Whether the guide bypasses its guide group's throttle settings. When true,
+          # archiving the guide does not open a new throttle window.
+          unthrottled: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel_id: String,
+              guide_id: String,
+              guide_key: String,
+              guide_step_ref: String,
+              is_final: T::Boolean,
+              tenant: String,
+              unthrottled: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_interacted_request.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideInteractedRequest < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideInteractedRequest,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The unique identifier for the guide.
+        sig { returns(String) }
+        attr_accessor :guide_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The step reference of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_step_ref
+
+        # Metadata about the interaction.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tenant
+
+        sig { params(tenant: String).void }
+        attr_writer :tenant
+
+        # A request to mark a guide as interacted with.
+        sig do
+          params(
+            channel_id: String,
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            metadata: T::Hash[Symbol, T.anything],
+            tenant: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The unique identifier for the guide.
+          guide_id:,
+          # The key of the guide.
+          guide_key:,
+          # The step reference of the guide.
+          guide_step_ref:,
+          # Metadata about the interaction.
+          metadata: nil,
+          # The tenant ID of the guide.
+          tenant: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel_id: String,
+              guide_id: String,
+              guide_key: String,
+              guide_step_ref: String,
+              metadata: T::Hash[Symbol, T.anything],
+              tenant: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Users
-      class GuideMarkMessageAsArchivedParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsArchivedParams < Knockapi::Models::Users::GuideArchivedRequest
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
@@ -18,114 +18,18 @@ module Knockapi
         sig { returns(String) }
         attr_accessor :user_id
 
-        sig { returns(String) }
-        attr_accessor :message_id
-
-        # The unique identifier for the channel.
-        sig { returns(String) }
-        attr_accessor :channel_id
-
-        # The unique identifier for the guide.
-        sig { returns(String) }
-        attr_accessor :guide_id
-
-        # The key of the guide.
-        sig { returns(String) }
-        attr_accessor :guide_key
-
-        # The step reference of the guide.
-        sig { returns(String) }
-        attr_accessor :guide_step_ref
-
-        # The content of the guide.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :content
-
-        sig { params(content: T::Hash[Symbol, T.anything]).void }
-        attr_writer :content
-
-        # The data of the guide.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :data
-
-        sig { params(data: T::Hash[Symbol, T.anything]).void }
-        attr_writer :data
-
-        # Whether the guide is final.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_final
-
-        sig { params(is_final: T::Boolean).void }
-        attr_writer :is_final
-
-        # The metadata of the guide.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :metadata
-
-        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
-        attr_writer :metadata
-
-        # The tenant ID of the guide.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :tenant
-
         sig do
           params(
             user_id: String,
-            message_id: String,
-            channel_id: String,
-            guide_id: String,
-            guide_key: String,
-            guide_step_ref: String,
-            content: T::Hash[Symbol, T.anything],
-            data: T::Hash[Symbol, T.anything],
-            is_final: T::Boolean,
-            metadata: T::Hash[Symbol, T.anything],
-            tenant: T.nilable(String),
             request_options: Knockapi::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(
-          user_id:,
-          message_id:,
-          # The unique identifier for the channel.
-          channel_id:,
-          # The unique identifier for the guide.
-          guide_id:,
-          # The key of the guide.
-          guide_key:,
-          # The step reference of the guide.
-          guide_step_ref:,
-          # The content of the guide.
-          content: nil,
-          # The data of the guide.
-          data: nil,
-          # Whether the guide is final.
-          is_final: nil,
-          # The metadata of the guide.
-          metadata: nil,
-          # The tenant ID of the guide.
-          tenant: nil,
-          request_options: {}
-        )
+        def self.new(user_id:, request_options: {})
         end
 
         sig do
           override.returns(
-            {
-              user_id: String,
-              message_id: String,
-              channel_id: String,
-              guide_id: String,
-              guide_key: String,
-              guide_step_ref: String,
-              content: T::Hash[Symbol, T.anything],
-              data: T::Hash[Symbol, T.anything],
-              is_final: T::Boolean,
-              metadata: T::Hash[Symbol, T.anything],
-              tenant: T.nilable(String),
-              request_options: Knockapi::RequestOptions
-            }
+            { user_id: String, request_options: Knockapi::RequestOptions }
           )
         end
         def to_hash