knockapi 1.38.0 → 1.40.0

data/rbi/knockapi/resources/users/guides.rbi

@@ -37,23 +37,19 @@ module Knockapi
         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),
+            tenant: String,
+            unthrottled: T::Boolean,
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
+          ).returns(Knockapi::Users::GuideActionResponse)
         end
         def mark_message_as_archived(
           # The unique identifier of the user.
           user_id,
-          message_id,
           # The unique identifier for the channel.
           channel_id:,
           # The unique identifier for the guide.
@@ -62,16 +58,13 @@ module Knockapi
           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,
+          # Whether the guide bypasses its guide group's throttle settings. When true,
+          # archiving the guide does not open a new throttle window.
+          unthrottled: nil,
           request_options: {}
         )
         end
@@ -81,25 +74,18 @@ module Knockapi
         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),
+            tenant: String,
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(
-            Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
-          )
+          ).returns(Knockapi::Users::GuideActionResponse)
         end
         def mark_message_as_interacted(
           # The unique identifier of the user.
           user_id,
-          message_id,
           # The unique identifier for the channel.
           channel_id:,
           # The unique identifier for the guide.
@@ -108,13 +94,7 @@ module Knockapi
           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 about the interaction.
           metadata: nil,
           # The tenant ID of the guide.
           tenant: nil,
@@ -127,39 +107,73 @@ module Knockapi
         sig do
           params(
             user_id: String,
-            message_id: String,
             channel_id: String,
+            content: T::Hash[Symbol, T.anything],
             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),
+            tenant: String,
             request_options: Knockapi::RequestOptions::OrHash
-          ).returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
+          ).returns(Knockapi::Users::GuideActionResponse)
         end
         def mark_message_as_seen(
           # The unique identifier of the user.
           user_id,
-          message_id,
           # 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 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: {}
+        )
+        end
+
+        # Resets the engagement state of a guide for a user, removing the guide's
+        # engagement log entry so the next interaction creates a fresh engagement.
+        sig do
+          params(
+            user_id: String,
+            guide_key: String,
+            tenant: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Users::GuideActionResponse)
+        end
+        def reset_guide_engagements(
+          # The unique identifier of the user.
+          user_id,
+          # The key of the guide.
+          guide_key:,
+          # The tenant ID of the guide.
+          tenant: nil,
+          request_options: {}
+        )
+        end
+
+        # Records that a guide has been unarchived, triggering any associated unarchived
+        # events.
+        sig do
+          params(
+            user_id: String,
+            guide_key: String,
+            tenant: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Users::GuideActionResponse)
+        end
+        def unarchive_guide_message(
+          # The unique identifier of the user.
+          user_id,
+          # The key of the guide.
+          guide_key:,
           # The tenant ID of the guide.
           tenant: nil,
           request_options: {}

data/rbi/knockapi/resources/users/preference_center.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Users
+      # The preference center is a hosted page where users can manage their notification
+      # preferences.
+      class PreferenceCenter
+        # Generates a signed preference center URL and token for the given user in the
+        # current environment.
+        sig do
+          params(
+            user_id: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            Knockapi::Models::Users::PreferenceCenterGenerateSignedURLResponse
+          )
+        end
+        def generate_signed_url(
+          # The unique identifier of the user.
+          user_id,
+          request_options: {}
+        )
+        end
+
+        # Returns the preference center config with environment metadata for the given
+        # user.
+        sig do
+          params(
+            user_id: String,
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::Models::Users::PreferenceCenterGetConfigResponse)
+        end
+        def get_config(
+          # The unique identifier of the user.
+          user_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/users.rbi

@@ -20,6 +20,11 @@ module Knockapi
       sig { returns(Knockapi::Resources::Users::Bulk) }
       attr_reader :bulk
 
+      # The preference center is a hosted page where users can manage their notification
+      # preferences.
+      sig { returns(Knockapi::Resources::Users::PreferenceCenter) }
+      attr_reader :preference_center
+
       # Create or update a user with the provided identification data. When you identify
       # an existing user, the system merges the properties you specific with what is
       # currently set on the user, updating only the fields included in your requests.
@@ -408,7 +413,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[
@@ -438,7 +449,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.

data/sig/knockapi/models/audience_add_members_params.rbs

@@ -3,7 +3,7 @@ module Knockapi
     type audience_add_members_params =
       {
         key: String,
-        members: ::Array[Knockapi::AudienceAddMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         create_audience: bool
       }
       & Knockapi::Internal::Type::request_parameters
@@ -14,7 +14,7 @@ module Knockapi
 
       attr_accessor key: String
 
-      attr_accessor members: ::Array[Knockapi::AudienceAddMembersParams::Member]
+      attr_accessor members: ::Array[Knockapi::AudienceMemberRequest]
 
       attr_reader create_audience: bool?
 
@@ -22,36 +22,17 @@ module Knockapi
 
       def initialize: (
         key: String,
-        members: ::Array[Knockapi::AudienceAddMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         ?create_audience: bool,
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
         key: String,
-        members: ::Array[Knockapi::AudienceAddMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         create_audience: bool,
         request_options: Knockapi::RequestOptions
       }
-
-      type member =
-        { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
-
-      class Member < Knockapi::Internal::Type::BaseModel
-        attr_accessor user: Knockapi::InlineIdentifyUserRequest
-
-        attr_accessor tenant: String?
-
-        def initialize: (
-          user: Knockapi::InlineIdentifyUserRequest,
-          ?tenant: String?
-        ) -> void
-
-        def to_hash: -> {
-          user: Knockapi::InlineIdentifyUserRequest,
-          tenant: String?
-        }
-      end
     end
   end
 end

data/sig/knockapi/models/audience_member_request.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Models
+    type audience_member_request =
+      { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
+
+    class AudienceMemberRequest < Knockapi::Internal::Type::BaseModel
+      attr_accessor user: Knockapi::InlineIdentifyUserRequest
+
+      attr_accessor tenant: String?
+
+      def initialize: (
+        user: Knockapi::InlineIdentifyUserRequest,
+        ?tenant: String?
+      ) -> void
+
+      def to_hash: -> {
+        user: Knockapi::InlineIdentifyUserRequest,
+        tenant: String?
+      }
+    end
+  end
+end

data/sig/knockapi/models/audience_remove_members_params.rbs

@@ -1,10 +1,7 @@
 module Knockapi
   module Models
     type audience_remove_members_params =
-      {
-        key: String,
-        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
-      }
+      { key: String, members: ::Array[Knockapi::AudienceMemberRequest] }
       & Knockapi::Internal::Type::request_parameters
 
     class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
@@ -13,38 +10,19 @@ module Knockapi
 
       attr_accessor key: String
 
-      attr_accessor members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
+      attr_accessor members: ::Array[Knockapi::AudienceMemberRequest]
 
       def initialize: (
         key: String,
-        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
         key: String,
-        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         request_options: Knockapi::RequestOptions
       }
-
-      type member =
-        { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
-
-      class Member < Knockapi::Internal::Type::BaseModel
-        attr_accessor user: Knockapi::InlineIdentifyUserRequest
-
-        attr_accessor tenant: String?
-
-        def initialize: (
-          user: Knockapi::InlineIdentifyUserRequest,
-          ?tenant: String?
-        ) -> void
-
-        def to_hash: -> {
-          user: Knockapi::InlineIdentifyUserRequest,
-          tenant: String?
-        }
-      end
     end
   end
 end

data/sig/knockapi/models/list_messages_response.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Models
+    type list_messages_response =
+      { items: ::Array[Knockapi::Message], page_info: Knockapi::PageInfo }
+
+    class ListMessagesResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor items: ::Array[Knockapi::Message]
+
+      attr_accessor page_info: Knockapi::PageInfo
+
+      def initialize: (
+        items: ::Array[Knockapi::Message],
+        page_info: Knockapi::PageInfo
+      ) -> void
+
+      def to_hash: -> {
+        items: ::Array[Knockapi::Message],
+        page_info: Knockapi::PageInfo
+      }
+    end
+  end
+end

data/sig/knockapi/models/list_schedules_response.rbs

@@ -0,0 +1,22 @@
+module Knockapi
+  module Models
+    type list_schedules_response =
+      { entries: ::Array[Knockapi::Schedule], page_info: Knockapi::PageInfo }
+
+    class ListSchedulesResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor entries: ::Array[Knockapi::Schedule]
+
+      attr_accessor page_info: Knockapi::PageInfo
+
+      def initialize: (
+        entries: ::Array[Knockapi::Schedule],
+        page_info: Knockapi::PageInfo
+      ) -> void
+
+      def to_hash: -> {
+        entries: ::Array[Knockapi::Schedule],
+        page_info: Knockapi::PageInfo
+      }
+    end
+  end
+end

data/sig/knockapi/models/list_subscriptions_response.rbs

@@ -0,0 +1,25 @@
+module Knockapi
+  module Models
+    type list_subscriptions_response =
+      {
+        entries: ::Array[Knockapi::Recipients::Subscription],
+        page_info: Knockapi::PageInfo
+      }
+
+    class ListSubscriptionsResponse < Knockapi::Internal::Type::BaseModel
+      attr_accessor entries: ::Array[Knockapi::Recipients::Subscription]
+
+      attr_accessor page_info: Knockapi::PageInfo
+
+      def initialize: (
+        entries: ::Array[Knockapi::Recipients::Subscription],
+        page_info: Knockapi::PageInfo
+      ) -> void
+
+      def to_hash: -> {
+        entries: ::Array[Knockapi::Recipients::Subscription],
+        page_info: Knockapi::PageInfo
+      }
+    end
+  end
+end

data/sig/knockapi/models/message.rbs

@@ -310,18 +310,41 @@ module Knockapi
         end
       end
 
-      type recipient_snapshot = { email: String, name: String? }
+      type recipient_snapshot =
+        {
+          channel_id: String?,
+          email: String?,
+          name: String?,
+          user_id: String?,
+          via_incoming_webhook: bool?
+        }
 
       class RecipientSnapshot < Knockapi::Internal::Type::BaseModel
-        attr_reader email: String?
+        attr_accessor channel_id: String?
 
-        def email=: (String) -> String
+        attr_accessor email: String?
 
         attr_accessor name: String?
 
-        def initialize: (?email: String, ?name: String?) -> void
+        attr_accessor user_id: String?
+
+        attr_accessor via_incoming_webhook: bool?
+
+        def initialize: (
+          ?channel_id: String?,
+          ?email: String?,
+          ?name: String?,
+          ?user_id: String?,
+          ?via_incoming_webhook: bool?
+        ) -> void
 
-        def to_hash: -> { email: String, name: String? }
+        def to_hash: -> {
+          channel_id: String?,
+          email: String?,
+          name: String?,
+          user_id: String?,
+          via_incoming_webhook: bool?
+        }
       end
     end
   end