knockapi 1.33.0 → 1.35.0

data/lib/knockapi/models/user_list_preferences_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:, request_options: {})
+      #   @param user_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/user_list_schedules_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute after
       #   The cursor to fetch entries after.
       #
@@ -37,7 +42,9 @@ module Knockapi
       #   @return [String, nil]
       optional :workflow, String
 
-      # @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
+      # @!method initialize(user_id:, after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
+      #   @param user_id [String]
+      #
       #   @param after [String] The cursor to fetch entries after.
       #
       #   @param before [String] The cursor to fetch entries before.

data/lib/knockapi/models/user_list_subscriptions_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute after
       #   The cursor to fetch entries after.
       #
@@ -38,7 +43,9 @@ module Knockapi
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(after: nil, before: nil, include: nil, objects: nil, page_size: nil, request_options: {})
+      # @!method initialize(user_id:, after: nil, before: nil, include: nil, objects: nil, page_size: nil, request_options: {})
+      #   @param user_id [String]
+      #
       #   @param after [String] The cursor to fetch entries after.
       #
       #   @param before [String] The cursor to fetch entries before.

data/lib/knockapi/models/user_merge_params.rb

@@ -7,13 +7,20 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute from_user_id
       #   The user ID to merge from.
       #
       #   @return [String]
       required :from_user_id, String
 
-      # @!method initialize(from_user_id:, request_options: {})
+      # @!method initialize(user_id:, from_user_id:, request_options: {})
+      #   @param user_id [String]
+      #
       #   @param from_user_id [String] The user ID to merge from.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]

data/lib/knockapi/models/user_set_channel_data_params.rb

@@ -7,7 +7,19 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute channel_id
+      #
+      #   @return [String]
+      required :channel_id, String
+
+      # @!method initialize(user_id:, channel_id:, request_options: {})
+      #   @param user_id [String]
+      #   @param channel_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/user_set_preferences_params.rb

@@ -7,7 +7,19 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(user_id:, id:, request_options: {})
+      #   @param user_id [String]
+      #   @param id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/user_unset_channel_data_params.rb

@@ -7,7 +7,19 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute channel_id
+      #
+      #   @return [String]
+      required :channel_id, String
+
+      # @!method initialize(user_id:, channel_id:, request_options: {})
+      #   @param user_id [String]
+      #   @param channel_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/user_update_params.rb

@@ -7,7 +7,13 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:, request_options: {})
+      #   @param user_id [String]
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/knockapi/models/users/feed_get_settings_params.rb

@@ -8,7 +8,19 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(user_id:, id:, request_options: {})
+        #   @param user_id [String]
+        #   @param id [String]
         #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/knockapi/models/users/feed_list_items_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute after
         #   The cursor to fetch entries after.
         #
@@ -99,10 +109,14 @@ module Knockapi
         #   @return [Array<String>, nil]
         optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(after: nil, archived: nil, before: nil, exclude: nil, has_tenant: nil, inserted_at: nil, locale: nil, mode: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        # @!method initialize(user_id:, id:, after: nil, archived: nil, before: nil, exclude: nil, has_tenant: nil, inserted_at: nil, locale: nil, mode: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Users::FeedListItemsParams} for more details.
         #
+        #   @param user_id [String]
+        #
+        #   @param id [String]
+        #
         #   @param after [String] The cursor to fetch entries after.
         #
         #   @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.

data/lib/knockapi/models/users/guide_get_channel_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute channel_id
+        #
+        #   @return [String]
+        required :channel_id, String
+
         # @!attribute data
         #   The data (JSON encoded object) to use for targeting and rendering guides.
         #
@@ -26,7 +36,11 @@ module Knockapi
         #   @return [String, nil]
         optional :type, String
 
-        # @!method initialize(data: nil, tenant: nil, type: nil, request_options: {})
+        # @!method initialize(user_id:, channel_id:, data: nil, tenant: nil, type: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param channel_id [String]
+        #
         #   @param data [String] The data (JSON encoded object) to use for targeting and rendering guides.
         #
         #   @param tenant [String] The tenant ID to use for targeting and rendering guides.

data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
         # @!attribute channel_id
         #   The unique identifier for the channel.
         #
@@ -62,7 +72,11 @@ module Knockapi
         #   @return [String, nil]
         optional :tenant, String, nil?: true
 
-        # @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        # @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param message_id [String]
+        #
         #   @param channel_id [String] The unique identifier for the channel.
         #
         #   @param guide_id [String] The unique identifier for the guide.

data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
         # @!attribute channel_id
         #   The unique identifier for the channel.
         #
@@ -62,7 +72,11 @@ module Knockapi
         #   @return [String, nil]
         optional :tenant, String, nil?: true
 
-        # @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        # @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param message_id [String]
+        #
         #   @param channel_id [String] The unique identifier for the channel.
         #
         #   @param guide_id [String] The unique identifier for the guide.

data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb

@@ -8,6 +8,16 @@ module Knockapi
         extend Knockapi::Internal::Type::RequestParameters::Converter
         include Knockapi::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
         # @!attribute channel_id
         #   The unique identifier for the channel.
         #
@@ -62,7 +72,11 @@ module Knockapi
         #   @return [String, nil]
         optional :tenant, String, nil?: true
 
-        # @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        # @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param message_id [String]
+        #
         #   @param channel_id [String] The unique identifier for the channel.
         #
         #   @param guide_id [String] The unique identifier for the guide.

data/lib/knockapi/models/workflow_cancel_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute key
+      #
+      #   @return [String]
+      required :key, String
+
       # @!attribute cancellation_key
       #   An optional key that is used to reference a specific workflow trigger request
       #   when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
@@ -26,10 +31,12 @@ module Knockapi
                -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
                nil?: true
 
-      # @!method initialize(cancellation_key:, recipients: nil, request_options: {})
+      # @!method initialize(key:, cancellation_key:, recipients: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::WorkflowCancelParams} for more details.
       #
+      #   @param key [String]
+      #
       #   @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
       #
       #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all

data/lib/knockapi/models/workflow_trigger_params.rb

@@ -7,6 +7,11 @@ module Knockapi
       extend Knockapi::Internal::Type::RequestParameters::Converter
       include Knockapi::Internal::Type::RequestParameters
 
+      # @!attribute key
+      #
+      #   @return [String]
+      required :key, String
+
       # @!attribute recipients
       #   The recipients to trigger the workflow for. Can inline identify users, objects,
       #   or use a list of user IDs. Limited to 1,000 recipients.
@@ -47,10 +52,12 @@ module Knockapi
       #   @return [String, Knockapi::Models::TenantRequest, nil]
       optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
 
-      # @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
+      # @!method initialize(key:, recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Knockapi::Models::WorkflowTriggerParams} for more details.
       #
+      #   @param key [String]
+      #
       #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
       #
       #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.33.0"
+  VERSION = "1.35.0"
 end

data/rbi/knockapi/models/audience_add_members_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::AudienceAddMembersParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # A list of audience members to add. You can add up to 1,000 members per request.
       sig { returns(T::Array[Knockapi::AudienceAddMembersParams::Member]) }
       attr_accessor :members
@@ -24,12 +27,14 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
           create_audience: T::Boolean,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # A list of audience members to add. You can add up to 1,000 members per request.
         members:,
         # Create the audience if it does not exist.
@@ -41,6 +46,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             members: T::Array[Knockapi::AudienceAddMembersParams::Member],
             create_audience: T::Boolean,
             request_options: Knockapi::RequestOptions

data/rbi/knockapi/models/audience_list_members_params.rbi

@@ -14,15 +14,23 @@ module Knockapi
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          key: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(key:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          { key: String, request_options: Knockapi::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/knockapi/models/audience_remove_members_params.rbi

@@ -14,6 +14,9 @@ module Knockapi
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # A list of audience members to remove. You can remove up to 1,000 members per
       # request.
       sig { returns(T::Array[Knockapi::AudienceRemoveMembersParams::Member]) }
@@ -21,12 +24,14 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           members:
             T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # A list of audience members to remove. You can remove up to 1,000 members per
         # request.
         members:,
@@ -37,6 +42,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             members: T::Array[Knockapi::AudienceRemoveMembersParams::Member],
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/bulk_operation_get_params.rbi

@@ -11,15 +11,23 @@ module Knockapi
           T.any(Knockapi::BulkOperationGetParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          { id: String, request_options: Knockapi::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi

@@ -15,6 +15,16 @@ module Knockapi
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        sig do
+          returns(
+            Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
         # Limits the results to messages with the given archived status.
         sig do
           returns(
@@ -122,6 +132,9 @@ module Knockapi
 
         sig do
           params(
+            channel_id: String,
+            action:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
             archived:
               Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
             delivery_status:
@@ -139,6 +152,8 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
+          channel_id:,
+          action:,
           # Limits the results to messages with the given archived status.
           archived: nil,
           # Limits the results to messages with the given delivery status.
@@ -168,6 +183,9 @@ module Knockapi
         sig do
           override.returns(
             {
+              channel_id: String,
+              action:
+                Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
               archived:
                 Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
               delivery_status:

data/rbi/knockapi/models/condition.rbi

@@ -113,6 +113,8 @@ module Knockapi
             :is_timestamp_between,
             Knockapi::Condition::Operator::TaggedSymbol
           )
+        IS_BETWEEN =
+          T.let(:is_between, Knockapi::Condition::Operator::TaggedSymbol)
         IS_AUDIENCE_MEMBER =
           T.let(
             :is_audience_member,

data/rbi/knockapi/models/message_archive_params.rbi

@@ -11,15 +11,23 @@ module Knockapi
           T.any(Knockapi::MessageArchiveParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :message_id
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          message_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(message_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          { message_id: String, request_options: Knockapi::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/knockapi/models/message_event.rbi

@@ -93,6 +93,8 @@ module Knockapi
           T.let(:"message.archived", Knockapi::MessageEvent::Type::TaggedSymbol)
         MESSAGE_BOUNCED =
           T.let(:"message.bounced", Knockapi::MessageEvent::Type::TaggedSymbol)
+        MESSAGE_CREATED =
+          T.let(:"message.created", Knockapi::MessageEvent::Type::TaggedSymbol)
         MESSAGE_DELIVERED =
           T.let(
             :"message.delivered",

data/rbi/knockapi/models/message_get_content_params.rbi

@@ -11,15 +11,23 @@ module Knockapi
           T.any(Knockapi::MessageGetContentParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :message_id
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          message_id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(message_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          { message_id: String, request_options: Knockapi::RequestOptions }
+        )
+      end
       def to_hash
       end
     end