knockapi 1.38.0 → 1.40.0

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

@@ -0,0 +1,36 @@
+module Knockapi
+  module Models
+    module Users
+      type guide_unarchive_guide_message_params =
+        { user_id: String, guide_key: String, tenant: String }
+        & Knockapi::Internal::Type::request_parameters
+
+      class GuideUnarchiveGuideMessageParams < 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/preference_center_branding_config.rbs

@@ -0,0 +1,37 @@
+module Knockapi
+  module Models
+    module Users
+      type preference_center_branding_config =
+        {
+          icon_url: String?,
+          logo_url: String?,
+          primary_color: String?,
+          primary_color_contrast: String?
+        }
+
+      class PreferenceCenterBrandingConfig < Knockapi::Internal::Type::BaseModel
+        attr_accessor icon_url: String?
+
+        attr_accessor logo_url: String?
+
+        attr_accessor primary_color: String?
+
+        attr_accessor primary_color_contrast: String?
+
+        def initialize: (
+          ?icon_url: String?,
+          ?logo_url: String?,
+          ?primary_color: String?,
+          ?primary_color_contrast: String?
+        ) -> void
+
+        def to_hash: -> {
+          icon_url: String?,
+          logo_url: String?,
+          primary_color: String?,
+          primary_color_contrast: String?
+        }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+module Knockapi
+  module Models
+    module Users
+      type preference_center_generate_signed_url_response =
+        { token: String, url: String }
+
+      class PreferenceCenterGenerateSignedURLResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor token: String
+
+        attr_accessor url: String
+
+        def initialize: (token: String, url: String) -> void
+
+        def to_hash: -> { token: String, url: String }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,189 @@
+module Knockapi
+  module Models
+    module Users
+      type preference_center_get_config_response =
+        {
+          account_name: String?,
+          branding: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Branding,
+          config: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config,
+          enabled: bool,
+          user_email: String?,
+          knock_branding_required: bool
+        }
+
+      class PreferenceCenterGetConfigResponse < Knockapi::Internal::Type::BaseModel
+        attr_accessor account_name: String?
+
+        attr_accessor branding: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Branding
+
+        attr_accessor config: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config
+
+        attr_accessor enabled: bool
+
+        attr_accessor user_email: String?
+
+        attr_reader knock_branding_required: bool?
+
+        def knock_branding_required=: (bool) -> bool
+
+        def initialize: (
+          account_name: String?,
+          branding: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Branding,
+          config: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config,
+          enabled: bool,
+          user_email: String?,
+          ?knock_branding_required: bool
+        ) -> void
+
+        def to_hash: -> {
+          account_name: String?,
+          branding: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Branding,
+          config: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config,
+          enabled: bool,
+          user_email: String?,
+          knock_branding_required: bool
+        }
+
+        type branding =
+          { dark: Knockapi::Users::PreferenceCenterBrandingConfig }
+
+        class Branding < Knockapi::Models::Users::PreferenceCenterBrandingConfig
+          def dark: -> Knockapi::Users::PreferenceCenterBrandingConfig?
+
+          def dark=: (
+            Knockapi::Users::PreferenceCenterBrandingConfig _
+          ) -> Knockapi::Users::PreferenceCenterBrandingConfig
+
+          def initialize: (
+            ?dark: Knockapi::Users::PreferenceCenterBrandingConfig
+          ) -> void
+
+          def to_hash: -> {
+            dark: Knockapi::Users::PreferenceCenterBrandingConfig
+          }
+        end
+
+        type config =
+          {
+            body: String,
+            rows: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row],
+            title: String,
+            show_account_name: bool
+          }
+
+        class Config < Knockapi::Internal::Type::BaseModel
+          attr_accessor body: String
+
+          attr_accessor rows: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row]
+
+          attr_accessor title: String
+
+          attr_reader show_account_name: bool?
+
+          def show_account_name=: (bool) -> bool
+
+          def initialize: (
+            body: String,
+            rows: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row],
+            title: String,
+            ?show_account_name: bool
+          ) -> void
+
+          def to_hash: -> {
+            body: String,
+            rows: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row],
+            title: String,
+            show_account_name: bool
+          }
+
+          type row =
+            {
+              name: String,
+              type: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::type_,
+              channel_types: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::channel_type]?,
+              description: String,
+              identifier: String?
+            }
+
+          class Row < Knockapi::Internal::Type::BaseModel
+            attr_accessor name: String
+
+            attr_accessor type: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::type_
+
+            attr_accessor channel_types: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::channel_type]?
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            attr_accessor identifier: String?
+
+            def initialize: (
+              name: String,
+              type: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::type_,
+              ?channel_types: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::channel_type]?,
+              ?description: String,
+              ?identifier: String?
+            ) -> void
+
+            def to_hash: -> {
+              name: String,
+              type: Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::type_,
+              channel_types: ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::channel_type]?,
+              description: String,
+              identifier: String?
+            }
+
+            type type_ =
+              :workflow
+              | :channel
+              | :category
+              | :channel_types
+              | :commercial_subscribed
+
+            module Type
+              extend Knockapi::Internal::Type::Enum
+
+              WORKFLOW: :workflow
+              CHANNEL: :channel
+              CATEGORY: :category
+              CHANNEL_TYPES: :channel_types
+              COMMERCIAL_SUBSCRIBED: :commercial_subscribed
+
+              def self?.values: -> ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::type_]
+            end
+
+            type channel_type =
+              :email
+              | :in_app
+              | :in_app_feed
+              | :in_app_guide
+              | :sms
+              | :push
+              | :chat
+              | :http
+              | :log
+              | :deferred_log
+
+            module ChannelType
+              extend Knockapi::Internal::Type::Enum
+
+              EMAIL: :email
+              IN_APP: :in_app
+              IN_APP_FEED: :in_app_feed
+              IN_APP_GUIDE: :in_app_guide
+              SMS: :sms
+              PUSH: :push
+              CHAT: :chat
+              HTTP: :http
+              LOG: :log
+              DEFERRED_LOG: :deferred_log
+
+              def self?.values: -> ::Array[Knockapi::Models::Users::PreferenceCenterGetConfigResponse::Config::Row::channel_type]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/knockapi/models.rbs

@@ -7,6 +7,8 @@ module Knockapi
 
   class AudienceMember = Knockapi::Models::AudienceMember
 
+  class AudienceMemberRequest = Knockapi::Models::AudienceMemberRequest
+
   class AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
 
   class BulkOperation = Knockapi::Models::BulkOperation
@@ -27,10 +29,18 @@ module Knockapi
 
   module Integrations = Knockapi::Models::Integrations
 
+  class ListMessagesResponse = Knockapi::Models::ListMessagesResponse
+
+  class ListSchedulesResponse = Knockapi::Models::ListSchedulesResponse
+
+  class ListSubscriptionsResponse = Knockapi::Models::ListSubscriptionsResponse
+
   class Message = Knockapi::Models::Message
 
   class MessageArchiveParams = Knockapi::Models::MessageArchiveParams
 
+  class MessageContents = Knockapi::Models::MessageContents
+
   class MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
 
   class MessageEvent = Knockapi::Models::MessageEvent
@@ -39,6 +49,10 @@ module Knockapi
 
   class MessageGetParams = Knockapi::Models::MessageGetParams
 
+  class MessageInAppFeedButtonSetBlock = Knockapi::Models::MessageInAppFeedButtonSetBlock
+
+  class MessageInAppFeedContentBlock = Knockapi::Models::MessageInAppFeedContentBlock
+
   class MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
 
   class MessageListDeliveryLogsParams = Knockapi::Models::MessageListDeliveryLogsParams
@@ -99,6 +113,8 @@ module Knockapi
 
   class PageInfo = Knockapi::Models::PageInfo
 
+  class PreferenceSetCommercialSubscribedSetting = Knockapi::Models::PreferenceSetCommercialSubscribedSetting
+
   module Providers = Knockapi::Models::Providers
 
   module Recipient = Knockapi::Models::Recipient

data/sig/knockapi/resources/audiences.rbs

@@ -3,7 +3,7 @@ module Knockapi
     class Audiences
       def add_members: (
         String key,
-        members: ::Array[Knockapi::AudienceAddMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         ?create_audience: bool,
         ?request_options: Knockapi::request_opts
       ) -> nil
@@ -15,7 +15,7 @@ module Knockapi
 
       def remove_members: (
         String key,
-        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
+        members: ::Array[Knockapi::AudienceMemberRequest],
         ?request_options: Knockapi::request_opts
       ) -> nil
 

data/sig/knockapi/resources/messages.rbs

@@ -34,7 +34,7 @@ module Knockapi
       def get_content: (
         String message_id,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Models::MessageGetContentResponse
+      ) -> Knockapi::MessageContents
 
       def list_activities: (
         String message_id,

data/sig/knockapi/resources/objects.rbs

@@ -130,7 +130,7 @@ module Knockapi
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
         ?channels: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::channel]?,
-        ?commercial_subscribed: bool?,
+        ?commercial_subscribed: Knockapi::Models::Recipients::PreferenceSetRequest::commercial_subscribed?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet

data/sig/knockapi/resources/users/guides.rbs

@@ -13,48 +13,52 @@ module Knockapi
 
         def mark_message_as_archived: (
           String user_id,
-          String message_id,
           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?,
+          ?tenant: String,
+          ?unthrottled: bool,
           ?request_options: Knockapi::request_opts
-        ) -> Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse
+        ) -> Knockapi::Users::GuideActionResponse
 
         def mark_message_as_interacted: (
           String user_id,
-          String message_id,
           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?,
+          ?tenant: String,
           ?request_options: Knockapi::request_opts
-        ) -> Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse
+        ) -> Knockapi::Users::GuideActionResponse
 
         def mark_message_as_seen: (
           String user_id,
-          String message_id,
           channel_id: String,
+          content: ::Hash[Symbol, top],
           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?,
+          ?tenant: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Users::GuideActionResponse
+
+        def reset_guide_engagements: (
+          String user_id,
+          guide_key: String,
+          ?tenant: String,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Users::GuideActionResponse
+
+        def unarchive_guide_message: (
+          String user_id,
+          guide_key: String,
+          ?tenant: String,
           ?request_options: Knockapi::request_opts
-        ) -> Knockapi::Models::Users::GuideMarkMessageAsSeenResponse
+        ) -> Knockapi::Users::GuideActionResponse
 
         def initialize: (client: Knockapi::Client) -> void
       end

data/sig/knockapi/resources/users/preference_center.rbs

@@ -0,0 +1,19 @@
+module Knockapi
+  module Resources
+    class Users
+      class PreferenceCenter
+        def generate_signed_url: (
+          String user_id,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::PreferenceCenterGenerateSignedURLResponse
+
+        def get_config: (
+          String user_id,
+          ?request_options: Knockapi::request_opts
+        ) -> Knockapi::Models::Users::PreferenceCenterGetConfigResponse
+
+        def initialize: (client: Knockapi::Client) -> void
+      end
+    end
+  end
+end

data/sig/knockapi/resources/users.rbs

@@ -7,6 +7,8 @@ module Knockapi
 
       attr_reader bulk: Knockapi::Resources::Users::Bulk
 
+      attr_reader preference_center: Knockapi::Resources::Users::PreferenceCenter
+
       def update: (
         String user_id,
         ?avatar: String?,
@@ -116,7 +118,7 @@ module Knockapi
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
         ?channels: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::channel]?,
-        ?commercial_subscribed: bool?,
+        ?commercial_subscribed: Knockapi::Models::Recipients::PreferenceSetRequest::commercial_subscribed?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet