knockapi 1.8.1 → 1.10.0

data/rbi/knockapi/resources/objects.rbi

@@ -27,7 +27,7 @@ module Knockapi
         before: nil,
         # Includes preferences of the objects in the response.
         include: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )
@@ -216,7 +216,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,
@@ -278,7 +278,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter schedules by tenant id.
         tenant: nil,
@@ -334,7 +334,7 @@ module Knockapi
         mode: nil,
         # Objects to filter by (only used if mode is `recipient`).
         objects: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Recipients to filter by (only used if mode is `object`).
         recipients: nil,

data/rbi/knockapi/resources/schedules.rbi

@@ -47,10 +47,10 @@ module Knockapi
         # (string), an inline user request (object), or an inline object request, which is
         # determined by the presence of a `collection` property.
         actor: nil,
-        # An optional map of data to pass into the workflow execution. There is a 1024
-        # byte limit on the size of any single string value (with the exception of
-        # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
@@ -93,10 +93,10 @@ module Knockapi
         # A reference to a recipient, either a user identifier (string) or an object
         # reference (ID, collection).
         actor: nil,
-        # An optional map of data to pass into the workflow execution. There is a 1024
-        # byte limit on the size of any single string value (with the exception of
-        # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
@@ -136,7 +136,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter by recipient references.
         recipients: nil,

data/rbi/knockapi/resources/tenants.rbi

@@ -24,7 +24,7 @@ module Knockapi
         before: nil,
         # Filter tenants by name.
         name: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Filter tenants by ID.
         tenant_id: nil,

data/rbi/knockapi/resources/users/feeds.rbi

@@ -13,7 +13,7 @@ module Knockapi
           ).returns(Knockapi::Models::Users::FeedGetSettingsResponse)
         end
         def get_settings(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the channel.
           id,
@@ -21,8 +21,20 @@ module Knockapi
         )
         end
 
-        # Returns a paginated list of feed items for a user, including metadata about the
-        # feed.
+        # Returns a paginated list of feed items for a user in reverse chronological
+        # order, including metadata about the feed. If the user has not yet been
+        # identified within Knock, an empty feed will be returned.
+        #
+        # You can customize the response using
+        # [response filters](/integrations/in-app/knock#customizing-api-response-content)
+        # to exclude or only include specific properties on your resources.
+        #
+        # **Notes:**
+        #
+        # - When making this call from a client-side environment, use your publishable key
+        #   along with a user token.
+        # - This endpoint’s rate limit is always scoped per-user and per-environment. This
+        #   is true even for requests made without a signed user token.
         sig do
           params(
             user_id: String,
@@ -45,7 +57,7 @@ module Knockapi
           )
         end
         def list_items(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the channel.
           id,
@@ -57,9 +69,9 @@ module Knockapi
           before: nil,
           # Whether the feed items have a tenant.
           has_tenant: nil,
-          # The number of items per page.
+          # The number of items per page (defaults to 50).
           page_size: nil,
-          # The source of the feed items.
+          # The workflow key associated with the message in the feed.
           source: nil,
           # The status of the feed items.
           status: nil,

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

@@ -16,7 +16,7 @@ module Knockapi
           ).returns(Knockapi::Models::Users::GuideGetChannelResponse)
         end
         def get_channel(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the channel.
           channel_id,
@@ -49,7 +49,7 @@ module Knockapi
           ).returns(Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse)
         end
         def mark_message_as_archived(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the message.
           message_id,
@@ -96,7 +96,7 @@ module Knockapi
           )
         end
         def mark_message_as_interacted(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the message.
           message_id,
@@ -141,7 +141,7 @@ module Knockapi
           ).returns(Knockapi::Models::Users::GuideMarkMessageAsSeenResponse)
         end
         def mark_message_as_seen(
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           user_id,
           # The unique identifier for the message.
           message_id,

data/rbi/knockapi/resources/users.rbi

@@ -49,9 +49,9 @@ module Knockapi
         ).returns(Knockapi::User)
       end
       def update(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
-        # URL to the user's avatar image.
+        # A URL for the avatar of the user.
         avatar: nil,
         # A request to set channel data for a type of channel inline.
         channel_data: nil,
@@ -97,7 +97,7 @@ module Knockapi
         before: nil,
         # Associated resources to include in the response.
         include: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )
@@ -140,7 +140,7 @@ module Knockapi
         ).returns(Knockapi::Recipients::RecipientsChannelData)
       end
       def get_channel_data(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         # The unique identifier for the channel.
         channel_id,
@@ -159,7 +159,7 @@ module Knockapi
         ).returns(Knockapi::Recipients::PreferenceSet)
       end
       def get_preferences(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         # Unique identifier for the preference set.
         id,
@@ -169,9 +169,9 @@ module Knockapi
       )
       end
 
-      # Returns a paginated list of messages for a specific user. Allows filtering by
-      # message status and provides various sorting options. Messages outside the
-      # account's retention window will not be included in the results.
+      # Returns a paginated list of messages for a specific user. Messages are sorted
+      # with the most recent ones appearing first. Messages outside the account's
+      # retention window will not be included in the results.
       sig do
         params(
           user_id: String,
@@ -210,7 +210,7 @@ module Knockapi
         # Limits the results to only the message IDs given (max 50). Note: when using this
         # option, the results will be subject to any other filters applied to the query.
         message_ids: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # Limits the results to messages triggered by the given workflow key.
         source: nil,
@@ -241,7 +241,7 @@ module Knockapi
         ).returns(T::Array[Knockapi::Recipients::PreferenceSet])
       end
       def list_preferences(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         request_options: {}
       )
@@ -266,7 +266,7 @@ module Knockapi
         after: nil,
         # The cursor to fetch entries before.
         before: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         # The tenant ID to filter schedules for.
         tenant: nil,
@@ -309,7 +309,7 @@ module Knockapi
         include: nil,
         # Only returns subscriptions for the specified object references.
         objects: nil,
-        # The number of items per page.
+        # The number of items per page (defaults to 50).
         page_size: nil,
         request_options: {}
       )
@@ -352,7 +352,7 @@ module Knockapi
         ).returns(Knockapi::Recipients::RecipientsChannelData)
       end
       def set_channel_data(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         # The unique identifier for the channel.
         channel_id,
@@ -394,7 +394,7 @@ module Knockapi
         ).returns(Knockapi::Recipients::PreferenceSet)
       end
       def set_preferences(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         # Unique identifier for the preference set.
         id,
@@ -419,7 +419,7 @@ module Knockapi
         ).returns(String)
       end
       def unset_channel_data(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the user.
         user_id,
         # The unique identifier for the channel.
         channel_id,

data/rbi/knockapi/resources/workflows.rbi

@@ -84,10 +84,10 @@ module Knockapi
         # subsequent cancellation. Should be unique across trigger requests to avoid
         # unintentional cancellations.
         cancellation_key: nil,
-        # An optional map of data to pass into the workflow execution. There is a 1024
-        # byte limit on the size of any single string value (with the exception of
-        # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
-        # size of the full `data` payload.
+        # An optional map of data to pass into the workflow execution. There is a 10MB
+        # limit on the size of the full `data` payload. Any individual string value
+        # greater than 1024 bytes in length will be
+        # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
         data: nil,
         # An request to set a tenant inline.
         tenant: nil,

data/sig/knockapi/models/message.rbs

@@ -164,7 +164,8 @@ module Knockapi
           _typename: String,
           categories: ::Array[String],
           key: String,
-          version_id: String
+          version_id: String,
+          step_ref: String?
         }
 
       class Source < Knockapi::Internal::Type::BaseModel
@@ -176,18 +177,22 @@ module Knockapi
 
         attr_accessor version_id: String
 
+        attr_accessor step_ref: String?
+
         def initialize: (
           _typename: String,
           categories: ::Array[String],
           key: String,
-          version_id: String
+          version_id: String,
+          ?step_ref: String?
         ) -> void
 
         def to_hash: -> {
           _typename: String,
           categories: ::Array[String],
           key: String,
-          version_id: String
+          version_id: String,
+          step_ref: String?
         }
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-18 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool