knockapi 1.2.0 → 1.3.0

data/sig/knockapi/models/user_list_preferences_params.rbs

@@ -8,6 +8,8 @@ module Knockapi
       include Knockapi::Internal::Type::RequestParameters
 
       def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> { request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/user_list_schedules_params.rbs

@@ -42,6 +42,15 @@ module Knockapi
         ?workflow: String,
         ?request_options: Knockapi::request_opts
       ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        page_size: Integer,
+        tenant: String,
+        workflow: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/user_list_subscriptions_params.rbs

@@ -4,7 +4,7 @@ module Knockapi
       {
         after: String,
         before: String,
-        include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
         objects: ::Array[String],
         page_size: Integer
       }
@@ -22,11 +22,11 @@ module Knockapi
 
       def before=: (String) -> String
 
-      attr_reader include: ::Array[Knockapi::UserListSubscriptionsParams::include_]?
+      attr_reader include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]?
 
       def include=: (
-        ::Array[Knockapi::UserListSubscriptionsParams::include_]
-      ) -> ::Array[Knockapi::UserListSubscriptionsParams::include_]
+        ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
+      ) -> ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
 
       attr_reader objects: ::Array[String]?
 
@@ -39,12 +39,21 @@ module Knockapi
       def initialize: (
         ?after: String,
         ?before: String,
-        ?include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        ?include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
         ?objects: ::Array[String],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
       ) -> void
 
+      def to_hash: -> {
+        after: String,
+        before: String,
+        include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
+        objects: ::Array[String],
+        page_size: Integer,
+        request_options: Knockapi::RequestOptions
+      }
+
       type include_ = :preferences
 
       module Include
@@ -52,7 +61,7 @@ module Knockapi
 
         PREFERENCES: :preferences
 
-        def self?.values: -> ::Array[Knockapi::UserListSubscriptionsParams::include_]
+        def self?.values: -> ::Array[Knockapi::Models::UserListSubscriptionsParams::include_]
       end
     end
   end

data/sig/knockapi/models/user_merge_params.rbs

@@ -13,6 +13,11 @@ module Knockapi
         from_user_id: String,
         ?request_options: Knockapi::request_opts
       ) -> void
+
+      def to_hash: -> {
+        from_user_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/user_set_channel_data_params.rbs

@@ -8,6 +8,8 @@ module Knockapi
       include Knockapi::Internal::Type::RequestParameters
 
       def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> { request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/user_set_preferences_params.rbs

@@ -8,6 +8,8 @@ module Knockapi
       include Knockapi::Internal::Type::RequestParameters
 
       def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> { request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/user_unset_channel_data_params.rbs

@@ -8,6 +8,8 @@ module Knockapi
       include Knockapi::Internal::Type::RequestParameters
 
       def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> { request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/user_update_params.rbs

@@ -8,6 +8,8 @@ module Knockapi
       include Knockapi::Internal::Type::RequestParameters
 
       def initialize: (?request_options: Knockapi::request_opts) -> void
+
+      def to_hash: -> { request_options: Knockapi::RequestOptions }
     end
   end
 end

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

@@ -15,6 +15,11 @@ module Knockapi
           user_ids: ::Array[String],
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          user_ids: ::Array[String],
+          request_options: Knockapi::RequestOptions
+        }
       end
     end
   end

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

@@ -15,6 +15,11 @@ module Knockapi
           users: ::Array[Knockapi::InlineIdentifyUserRequest],
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          users: ::Array[Knockapi::InlineIdentifyUserRequest],
+          request_options: Knockapi::RequestOptions
+        }
       end
     end
   end

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

@@ -21,6 +21,12 @@ module Knockapi
           user_ids: ::Array[String],
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          preferences: Knockapi::Recipients::PreferenceSetRequest,
+          user_ids: ::Array[String],
+          request_options: Knockapi::RequestOptions
+        }
       end
     end
   end

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

@@ -9,6 +9,8 @@ module Knockapi
         include Knockapi::Internal::Type::RequestParameters
 
         def initialize: (?request_options: Knockapi::request_opts) -> void
+
+        def to_hash: -> { request_options: Knockapi::RequestOptions }
       end
     end
   end

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

@@ -11,12 +11,18 @@ module Knockapi
           features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
         ) -> void
 
+        def to_hash: -> {
+          features: Knockapi::Models::Users::FeedGetSettingsResponse::Features
+        }
+
         type features = { branding_required: bool }
 
         class Features < Knockapi::Internal::Type::BaseModel
           attr_accessor branding_required: bool
 
           def initialize: (branding_required: bool) -> void
+
+          def to_hash: -> { branding_required: bool }
         end
       end
     end

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

@@ -78,6 +78,20 @@ module Knockapi
           ?request_options: Knockapi::request_opts
         ) -> void
 
+        def to_hash: -> {
+          after: String,
+          archived: Knockapi::Models::Users::FeedListItemsParams::archived,
+          before: String,
+          has_tenant: bool,
+          page_size: Integer,
+          source: String,
+          status: Knockapi::Models::Users::FeedListItemsParams::status,
+          tenant: String,
+          trigger_data: String,
+          workflow_categories: ::Array[String],
+          request_options: Knockapi::RequestOptions
+        }
+
         type archived = :exclude | :include | :only
 
         module Archived

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

@@ -81,6 +81,27 @@ module Knockapi
           ?seen_at: String?
         ) -> void
 
+        def to_hash: -> {
+          id: String,
+          _typename: String,
+          activities: ::Array[Knockapi::Activity],
+          actors: ::Array[Knockapi::Models::recipient],
+          blocks: ::Array[Knockapi::Models::Users::FeedListItemsResponse::block],
+          data: ::Hash[Symbol, top]?,
+          inserted_at: String,
+          source: Knockapi::Models::Users::FeedListItemsResponse::Source,
+          tenant: String?,
+          total_activities: Integer,
+          total_actors: Integer,
+          updated_at: String,
+          archived_at: String?,
+          clicked_at: String?,
+          interacted_at: String?,
+          link_clicked_at: String?,
+          read_at: String?,
+          seen_at: String?
+        }
+
         type block =
           Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock
           | Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
@@ -112,6 +133,13 @@ module Knockapi
               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
@@ -144,6 +172,12 @@ module Knockapi
               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
@@ -158,6 +192,8 @@ module Knockapi
                 label: String,
                 name: String
               ) -> void
+
+              def to_hash: -> { action: String, label: String, name: String }
             end
 
             type type_ = :button_set
@@ -197,6 +233,13 @@ module Knockapi
             key: String,
             version_id: String
           ) -> void
+
+          def to_hash: -> {
+            _typename: String,
+            categories: ::Array[String],
+            key: String,
+            version_id: String
+          }
         end
       end
     end

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

@@ -27,6 +27,13 @@ module Knockapi
           ?type: String,
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          data: String,
+          tenant: String,
+          type: String,
+          request_options: Knockapi::RequestOptions
+        }
       end
     end
   end

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

@@ -17,6 +17,11 @@ module Knockapi
           ?recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
         ) -> void
 
+        def to_hash: -> {
+          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
+          recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+        }
+
         type guide =
           {
             id: String,
@@ -48,6 +53,13 @@ module Knockapi
             ?metadata: ::Hash[Symbol, top],
             ?title: String
           ) -> void
+
+          def to_hash: -> {
+            id: String,
+            content: String,
+            metadata: ::Hash[Symbol, top],
+            title: String
+          }
         end
 
         type recipient = { id: String }
@@ -58,6 +70,8 @@ module Knockapi
           def id=: (String) -> String
 
           def initialize: (?id: String) -> void
+
+          def to_hash: -> { id: String }
         end
       end
     end

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

@@ -57,6 +57,19 @@ module Knockapi
           ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          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
     end
   end

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

@@ -7,6 +7,8 @@ module Knockapi
         attr_accessor status: String
 
         def initialize: (status: String) -> void
+
+        def to_hash: -> { status: String }
       end
     end
   end

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

@@ -57,6 +57,19 @@ module Knockapi
           ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          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
     end
   end

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

@@ -7,6 +7,8 @@ module Knockapi
         attr_accessor status: String
 
         def initialize: (status: String) -> void
+
+        def to_hash: -> { status: String }
       end
     end
   end

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

@@ -57,6 +57,19 @@ module Knockapi
           ?tenant: String?,
           ?request_options: Knockapi::request_opts
         ) -> void
+
+        def to_hash: -> {
+          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
     end
   end

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

@@ -7,6 +7,8 @@ module Knockapi
         attr_accessor status: String
 
         def initialize: (status: String) -> void
+
+        def to_hash: -> { status: String }
       end
     end
   end

data/sig/knockapi/models/workflow_cancel_params.rbs

@@ -20,6 +20,12 @@ module Knockapi
         ?recipients: ::Array[Knockapi::Models::recipient_reference]?,
         ?request_options: Knockapi::request_opts
       ) -> void
+
+      def to_hash: -> {
+        cancellation_key: String,
+        recipients: ::Array[Knockapi::Models::recipient_reference]?,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/workflow_trigger_params.rbs

@@ -32,6 +32,15 @@ module Knockapi
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts
       ) -> void
+
+      def to_hash: -> {
+        recipients: ::Array[Knockapi::Models::recipient_request],
+        actor: Knockapi::Models::recipient_request?,
+        cancellation_key: String?,
+        data: ::Hash[Symbol, top]?,
+        tenant: Knockapi::Models::inline_tenant_request?,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/workflow_trigger_response.rbs

@@ -6,6 +6,8 @@ module Knockapi
       attr_accessor workflow_run_id: String
 
       def initialize: (workflow_run_id: String) -> void
+
+      def to_hash: -> { workflow_run_id: String }
     end
   end
 end

data/sig/knockapi/resources/messages.rbs

@@ -7,19 +7,19 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?channel_id: String,
-        ?engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
+        ?engagement_status: ::Array[Knockapi::Models::MessageListParams::engagement_status],
         ?inserted_at: Knockapi::MessageListParams::InsertedAt,
         ?message_ids: ::Array[String],
         ?page_size: Integer,
         ?source: String,
-        ?status: ::Array[Knockapi::MessageListParams::status],
+        ?status: ::Array[Knockapi::Models::MessageListParams::status],
         ?tenant: String,
         ?trigger_data: String,
         ?workflow_categories: ::Array[String],
         ?workflow_recipient_run_id: String,
         ?workflow_run_id: String,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::Message]
 
       def archive: (
         String message_id,
@@ -51,7 +51,7 @@ module Knockapi
         ?before: String,
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageDeliveryLog]
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::MessageDeliveryLog]
 
       def list_events: (
         String message_id,
@@ -59,7 +59,7 @@ module Knockapi
         ?before: String,
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageEvent]
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::MessageEvent]
 
       def mark_as_interacted: (
         String message_id,

data/sig/knockapi/resources/objects.rbs

@@ -7,7 +7,7 @@ module Knockapi
         String collection,
         ?after: String,
         ?before: String,
-        ?include: ::Array[Knockapi::ObjectListParams::include_],
+        ?include: ::Array[Knockapi::Models::ObjectListParams::include_],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Internal::EntriesCursor[Knockapi::Object]
@@ -59,19 +59,19 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?channel_id: String,
-        ?engagement_status: ::Array[Knockapi::ObjectListMessagesParams::engagement_status],
+        ?engagement_status: ::Array[Knockapi::Models::ObjectListMessagesParams::engagement_status],
         ?inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt,
         ?message_ids: ::Array[String],
         ?page_size: Integer,
         ?source: String,
-        ?status: ::Array[Knockapi::ObjectListMessagesParams::status],
+        ?status: ::Array[Knockapi::Models::ObjectListMessagesParams::status],
         ?tenant: String,
         ?trigger_data: String,
         ?workflow_categories: ::Array[String],
         ?workflow_recipient_run_id: String,
         ?workflow_run_id: String,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::Message]
 
       def list_preferences: (
         String collection,
@@ -95,7 +95,7 @@ module Knockapi
         String object_id_,
         ?after: String,
         ?before: String,
-        ?include: ::Array[Knockapi::ObjectListSubscriptionsParams::include_],
+        ?include: ::Array[Knockapi::Models::ObjectListSubscriptionsParams::include_],
         ?mode: Knockapi::Models::ObjectListSubscriptionsParams::mode,
         ?objects: ::Array[Knockapi::ObjectListSubscriptionsParams::Object],
         ?page_size: Integer,
@@ -125,9 +125,9 @@ module Knockapi
         String collection,
         String object_id_,
         String id,
-        ?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
+        ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
-        ?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?,
+        ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet
 

data/sig/knockapi/resources/users.rbs

@@ -24,7 +24,7 @@ module Knockapi
       def list: (
         ?after: String,
         ?before: String,
-        ?include: ::Array[Knockapi::UserListParams::include_],
+        ?include: ::Array[Knockapi::Models::UserListParams::include_],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Internal::EntriesCursor[Knockapi::User]
@@ -57,19 +57,19 @@ module Knockapi
         ?after: String,
         ?before: String,
         ?channel_id: String,
-        ?engagement_status: ::Array[Knockapi::UserListMessagesParams::engagement_status],
+        ?engagement_status: ::Array[Knockapi::Models::UserListMessagesParams::engagement_status],
         ?inserted_at: Knockapi::UserListMessagesParams::InsertedAt,
         ?message_ids: ::Array[String],
         ?page_size: Integer,
         ?source: String,
-        ?status: ::Array[Knockapi::UserListMessagesParams::status],
+        ?status: ::Array[Knockapi::Models::UserListMessagesParams::status],
         ?tenant: String,
         ?trigger_data: String,
         ?workflow_categories: ::Array[String],
         ?workflow_recipient_run_id: String,
         ?workflow_run_id: String,
         ?request_options: Knockapi::request_opts
-      ) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
+      ) -> Knockapi::Internal::ItemsCursor[Knockapi::Message]
 
       def list_preferences: (
         String user_id,
@@ -90,7 +90,7 @@ module Knockapi
         String user_id,
         ?after: String,
         ?before: String,
-        ?include: ::Array[Knockapi::UserListSubscriptionsParams::include_],
+        ?include: ::Array[Knockapi::Models::UserListSubscriptionsParams::include_],
         ?objects: ::Array[String],
         ?page_size: Integer,
         ?request_options: Knockapi::request_opts
@@ -112,9 +112,9 @@ module Knockapi
       def set_preferences: (
         String user_id,
         String id,
-        ?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
+        ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
-        ?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?,
+        ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-21 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool