knockapi 1.38.0 → 1.40.0

data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Users
-      class GuideMarkMessageAsInteractedParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsInteractedParams < Knockapi::Models::Users::GuideInteractedRequest
         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

data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi

@@ -3,7 +3,7 @@
 module Knockapi
   module Models
     module Users
-      class GuideMarkMessageAsSeenParams < Knockapi::Internal::Type::BaseModel
+      class GuideMarkMessageAsSeenParams < Knockapi::Models::Users::GuideSeenRequest
         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

data/rbi/knockapi/models/users/guide_reset_guide_engagements_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideResetGuideEngagementsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideResetGuideEngagementsParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tenant
+
+        sig { params(tenant: String).void }
+        attr_writer :tenant
+
+        sig do
+          params(
+            user_id: String,
+            guide_key: String,
+            tenant: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          user_id:,
+          # The key of the guide.
+          guide_key:,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              user_id: String,
+              guide_key: String,
+              tenant: String,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_seen_request.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideSeenRequest < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideSeenRequest,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the channel.
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # The content of the guide.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :content
+
+        # 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 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
+
+        # 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 seen.
+        sig do
+          params(
+            channel_id: String,
+            content: T::Hash[Symbol, T.anything],
+            guide_id: String,
+            guide_key: String,
+            guide_step_ref: String,
+            data: T::Hash[Symbol, T.anything],
+            tenant: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the channel.
+          channel_id:,
+          # The content of the guide.
+          content:,
+          # 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 data of the guide.
+          data: nil,
+          # The tenant ID of the guide.
+          tenant: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel_id: String,
+              content: T::Hash[Symbol, T.anything],
+              guide_id: String,
+              guide_key: String,
+              guide_step_ref: String,
+              data: T::Hash[Symbol, T.anything],
+              tenant: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/guide_unarchive_guide_message_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class GuideUnarchiveGuideMessageParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::GuideUnarchiveGuideMessageParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        # The key of the guide.
+        sig { returns(String) }
+        attr_accessor :guide_key
+
+        # The tenant ID of the guide.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tenant
+
+        sig { params(tenant: String).void }
+        attr_writer :tenant
+
+        sig do
+          params(
+            user_id: String,
+            guide_key: String,
+            tenant: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          user_id:,
+          # The key of the guide.
+          guide_key:,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              user_id: String,
+              guide_key: String,
+              tenant: String,
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/preference_center_branding_config.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class PreferenceCenterBrandingConfig < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::PreferenceCenterBrandingConfig,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The icon URL for the preference center. Must point to a valid image with an
+        # image MIME type.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :icon_url
+
+        # The logo URL for the preference center. Must point to a valid image with an
+        # image MIME type.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :logo_url
+
+        # The primary color for the preference center, provided as a hex value.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_color
+
+        # The primary color contrast for the preference center, provided as a hex value.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_color_contrast
+
+        # The branding for the preference center, sourced from public environment
+        # variables.
+        sig do
+          params(
+            icon_url: T.nilable(String),
+            logo_url: T.nilable(String),
+            primary_color: T.nilable(String),
+            primary_color_contrast: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The icon URL for the preference center. Must point to a valid image with an
+          # image MIME type.
+          icon_url: nil,
+          # The logo URL for the preference center. Must point to a valid image with an
+          # image MIME type.
+          logo_url: nil,
+          # The primary color for the preference center, provided as a hex value.
+          primary_color: nil,
+          # The primary color contrast for the preference center, provided as a hex value.
+          primary_color_contrast: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              icon_url: T.nilable(String),
+              logo_url: T.nilable(String),
+              primary_color: T.nilable(String),
+              primary_color_contrast: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/preference_center_generate_signed_url_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class PreferenceCenterGenerateSignedURLParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::PreferenceCenterGenerateSignedURLParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        sig do
+          params(
+            user_id: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(user_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { user_id: String, request_options: Knockapi::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/preference_center_generate_signed_url_response.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class PreferenceCenterGenerateSignedURLResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Users::PreferenceCenterGenerateSignedURLResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The signed JWT token for the preference center, usable as the `/p/{token}` path
+        # segment.
+        sig { returns(String) }
+        attr_accessor :token
+
+        # The full URL to the preference center for the user.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # A signed preference center URL and token for a user.
+        sig { params(token: String, url: String).returns(T.attached_class) }
+        def self.new(
+          # The signed JWT token for the preference center, usable as the `/p/{token}` path
+          # segment.
+          token:,
+          # The full URL to the preference center for the user.
+          url:
+        )
+        end
+
+        sig { override.returns({ token: String, url: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/users/preference_center_get_config_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Users
+      class PreferenceCenterGetConfigParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Users::PreferenceCenterGetConfigParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        sig do
+          params(
+            user_id: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(user_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { user_id: String, request_options: Knockapi::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end