knockapi 1.33.0 → 1.35.0

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

@@ -15,6 +15,12 @@ module Knockapi
             )
           end
 
+        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
@@ -65,6 +71,8 @@ module Knockapi
 
         sig do
           params(
+            user_id: String,
+            message_id: String,
             channel_id: String,
             guide_id: String,
             guide_key: String,
@@ -78,6 +86,8 @@ module Knockapi
           ).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.
@@ -103,6 +113,8 @@ module Knockapi
         sig do
           override.returns(
             {
+              user_id: String,
+              message_id: String,
               channel_id: String,
               guide_id: String,
               guide_key: String,

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::WorkflowCancelParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # An optional key that is used to reference a specific workflow trigger request
       # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
       # request. Must be provided while triggering a workflow in order to enable
@@ -34,6 +37,7 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           cancellation_key: String,
           recipients:
             T.nilable(
@@ -48,6 +52,7 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # An optional key that is used to reference a specific workflow trigger request
         # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
         # request. Must be provided while triggering a workflow in order to enable
@@ -64,6 +69,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             cancellation_key: String,
             recipients:
               T.nilable(

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::WorkflowTriggerParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # The recipients to trigger the workflow for. Can inline identify users, objects,
       # or use a list of user IDs. Limited to 1,000 recipients.
       sig do
@@ -63,6 +66,7 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           recipients:
             T::Array[
               T.any(
@@ -86,6 +90,7 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # The recipients to trigger the workflow for. Can inline identify users, objects,
         # or use a list of user IDs. Limited to 1,000 recipients.
         recipients:,
@@ -113,6 +118,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             recipients:
               T::Array[
                 T.any(

data/sig/knockapi/models/audience_add_members_params.rbs

@@ -2,6 +2,7 @@ module Knockapi
   module Models
     type audience_add_members_params =
       {
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         create_audience: bool
       }
@@ -11,6 +12,8 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor key: String
+
       attr_accessor members: ::Array[Knockapi::AudienceAddMembersParams::Member]
 
       attr_reader create_audience: bool?
@@ -18,12 +21,14 @@ module Knockapi
       def create_audience=: (bool) -> bool
 
       def initialize: (
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         ?create_audience: bool,
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        key: String,
         members: ::Array[Knockapi::AudienceAddMembersParams::Member],
         create_audience: bool,
         request_options: Knockapi::RequestOptions

data/sig/knockapi/models/audience_list_members_params.rbs

@@ -1,15 +1,20 @@
 module Knockapi
   module Models
     type audience_list_members_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { key: String } & Knockapi::Internal::Type::request_parameters
 
     class AudienceListMembersParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor key: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        key: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> { key: String, request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/audience_remove_members_params.rbs

@@ -1,21 +1,28 @@
 module Knockapi
   module Models
     type audience_remove_members_params =
-      { members: ::Array[Knockapi::AudienceRemoveMembersParams::Member] }
+      {
+        key: String,
+        members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
+      }
       & Knockapi::Internal::Type::request_parameters
 
     class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor key: String
+
       attr_accessor members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
 
       def initialize: (
+        key: String,
         members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        key: String,
         members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/bulk_operation_get_params.rbs

@@ -1,15 +1,20 @@
 module Knockapi
   module Models
     type bulk_operation_get_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { id: String } & Knockapi::Internal::Type::request_parameters
 
     class BulkOperationGetParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Knockapi::RequestOptions }
     end
   end
 end

data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs

@@ -3,6 +3,8 @@ module Knockapi
     module Channels
       type bulk_update_message_status_params =
         {
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
@@ -20,6 +22,10 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        attr_accessor channel_id: String
+
+        attr_accessor action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action
+
         attr_reader archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived?
 
         def archived=: (
@@ -67,6 +73,8 @@ module Knockapi
         def workflows=: (::Array[String]) -> ::Array[String]
 
         def initialize: (
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           ?archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           ?delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           ?engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
@@ -81,6 +89,8 @@ module Knockapi
         ) -> void
 
         def to_hash: -> {
+          channel_id: String,
+          action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action,
           archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
           delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
           engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,

data/sig/knockapi/models/condition.rbs

@@ -47,6 +47,7 @@ module Knockapi
         | :is_timestamp_on_or_after_date
         | :is_timestamp_before_date
         | :is_timestamp_between
+        | :is_between
         | :is_audience_member
         | :is_not_audience_member
 
@@ -73,6 +74,7 @@ module Knockapi
         IS_TIMESTAMP_ON_OR_AFTER_DATE: :is_timestamp_on_or_after_date
         IS_TIMESTAMP_BEFORE_DATE: :is_timestamp_before_date
         IS_TIMESTAMP_BETWEEN: :is_timestamp_between
+        IS_BETWEEN: :is_between
         IS_AUDIENCE_MEMBER: :is_audience_member
         IS_NOT_AUDIENCE_MEMBER: :is_not_audience_member
 

data/sig/knockapi/models/message_archive_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_archive_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageArchiveParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_event.rbs

@@ -44,6 +44,7 @@ module Knockapi
       type type_ =
         :"message.archived"
         | :"message.bounced"
+        | :"message.created"
         | :"message.delivered"
         | :"message.delivery_attempted"
         | :"message.interacted"
@@ -63,6 +64,7 @@ module Knockapi
 
         MESSAGE_ARCHIVED: :"message.archived"
         MESSAGE_BOUNCED: :"message.bounced"
+        MESSAGE_CREATED: :"message.created"
         MESSAGE_DELIVERED: :"message.delivered"
         MESSAGE_DELIVERY_ATTEMPTED: :"message.delivery_attempted"
         MESSAGE_INTERACTED: :"message.interacted"

data/sig/knockapi/models/message_get_content_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_get_content_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageGetContentParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_get_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_get_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageGetParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_list_activities_params.rbs

@@ -2,6 +2,7 @@ module Knockapi
   module Models
     type message_list_activities_params =
       {
+        message_id: String,
         after: String,
         before: String,
         page_size: Integer,
@@ -13,6 +14,8 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor message_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -30,6 +33,7 @@ module Knockapi
       def trigger_data=: (String) -> String
 
       def initialize: (
+        message_id: String,
         ?after: String,
         ?before: String,
         ?page_size: Integer,
@@ -38,6 +42,7 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
+        message_id: String,
         after: String,
         before: String,
         page_size: Integer,

data/sig/knockapi/models/message_list_delivery_logs_params.rbs

@@ -1,13 +1,15 @@
 module Knockapi
   module Models
     type message_list_delivery_logs_params =
-      { after: String, before: String, page_size: Integer }
+      { message_id: String, after: String, before: String, page_size: Integer }
       & Knockapi::Internal::Type::request_parameters
 
     class MessageListDeliveryLogsParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor message_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -21,6 +23,7 @@ module Knockapi
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        message_id: String,
         ?after: String,
         ?before: String,
         ?page_size: Integer,
@@ -28,6 +31,7 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
+        message_id: String,
         after: String,
         before: String,
         page_size: Integer,

data/sig/knockapi/models/message_list_events_params.rbs

@@ -1,13 +1,15 @@
 module Knockapi
   module Models
     type message_list_events_params =
-      { after: String, before: String, page_size: Integer }
+      { message_id: String, after: String, before: String, page_size: Integer }
       & Knockapi::Internal::Type::request_parameters
 
     class MessageListEventsParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor message_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -21,6 +23,7 @@ module Knockapi
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        message_id: String,
         ?after: String,
         ?before: String,
         ?page_size: Integer,
@@ -28,6 +31,7 @@ module Knockapi
       ) -> void
 
       def to_hash: -> {
+        message_id: String,
         after: String,
         before: String,
         page_size: Integer,

data/sig/knockapi/models/message_mark_as_interacted_params.rbs

@@ -1,23 +1,27 @@
 module Knockapi
   module Models
     type message_mark_as_interacted_params =
-      { metadata: ::Hash[Symbol, top] }
+      { message_id: String, metadata: ::Hash[Symbol, top] }
       & Knockapi::Internal::Type::request_parameters
 
     class MessageMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor message_id: String
+
       attr_reader metadata: ::Hash[Symbol, top]?
 
       def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
       def initialize: (
+        message_id: String,
         ?metadata: ::Hash[Symbol, top],
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        message_id: String,
         metadata: ::Hash[Symbol, top],
         request_options: Knockapi::RequestOptions
       }

data/sig/knockapi/models/message_mark_as_read_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_mark_as_read_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageMarkAsReadParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_mark_as_seen_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_mark_as_seen_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_mark_as_unread_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_mark_as_unread_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageMarkAsUnreadParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_mark_as_unseen_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_mark_as_unseen_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageMarkAsUnseenParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/message_unarchive_params.rbs

@@ -1,15 +1,23 @@
 module Knockapi
   module Models
     type message_unarchive_params =
-      {  } & Knockapi::Internal::Type::request_parameters
+      { message_id: String } & Knockapi::Internal::Type::request_parameters
 
     class MessageUnarchiveParams < Knockapi::Internal::Type::BaseModel
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Knockapi::request_opts) -> void
+      attr_accessor message_id: String
 
-      def to_hash: -> { request_options: Knockapi::RequestOptions }
+      def initialize: (
+        message_id: String,
+        ?request_options: Knockapi::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Knockapi::RequestOptions
+      }
     end
   end
 end

data/sig/knockapi/models/object_add_subscriptions_params.rbs

@@ -2,6 +2,8 @@ module Knockapi
   module Models
     type object_add_subscriptions_params =
       {
+        collection: String,
+        object_id_: String,
         recipients: ::Array[Knockapi::Models::recipient_request],
         properties: ::Hash[Symbol, top]?
       }
@@ -11,17 +13,25 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      attr_accessor collection: String
+
+      attr_accessor object_id_: String
+
       attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
 
       attr_accessor properties: ::Hash[Symbol, top]?
 
       def initialize: (
+        collection: String,
+        object_id_: String,
         recipients: ::Array[Knockapi::Models::recipient_request],
         ?properties: ::Hash[Symbol, top]?,
         ?request_options: Knockapi::request_opts
       ) -> void
 
       def to_hash: -> {
+        collection: String,
+        object_id_: String,
         recipients: ::Array[Knockapi::Models::recipient_request],
         properties: ::Hash[Symbol, top]?,
         request_options: Knockapi::RequestOptions