knockapi 1.8.1 → 1.10.0

data/lib/knockapi/models/schedules/bulk_create_params.rb

@@ -36,10 +36,10 @@ module Knockapi
           optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
 
           # @!attribute data
-          #   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.
           #
           #   @return [Hash{Symbol=>Object}, nil]
           optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -86,7 +86,7 @@ module Knockapi
           #
           #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
           #
-          #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
+          #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
           #
           #   @param ending_at [Time, nil] The ending date and time for the schedule.
           #

data/lib/knockapi/models/tenant_list_params.rb

@@ -26,7 +26,7 @@ module Knockapi
       optional :name, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -44,7 +44,7 @@ module Knockapi
       #
       #   @param name [String] Filter tenants by name.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param tenant_id [String] Filter tenants by ID.
       #

data/lib/knockapi/models/user.rb

@@ -5,7 +5,7 @@ module Knockapi
     # @see Knockapi::Resources::Users#update
     class User < Knockapi::Internal::Type::BaseModel
       # @!attribute id
-      #   The ID for the user that you set when identifying them in Knock.
+      #   The unique identifier of the user.
       #
       #   @return [String]
       required :id, String
@@ -23,7 +23,7 @@ module Knockapi
       required :updated_at, Time
 
       # @!attribute avatar
-      #   URL to the user's avatar image.
+      #   A URL for the avatar of the user.
       #
       #   @return [String, nil]
       optional :avatar, String, nil?: true
@@ -70,13 +70,13 @@ module Knockapi
       #   receive notifications through Knock. Users are the most common recipients of
       #   notifications and are always referenced by your internal identifier.
       #
-      #   @param id [String] The ID for the user that you set when identifying them in Knock.
+      #   @param id [String] The unique identifier of the user.
       #
       #   @param _typename [String] The typename of the schema.
       #
       #   @param updated_at [Time] The timestamp when the resource was last updated.
       #
-      #   @param avatar [String, nil] URL to the user's avatar image.
+      #   @param avatar [String, nil] A URL for the avatar of the user.
       #
       #   @param created_at [Time, nil] The creation date of the user from your system.
       #

data/lib/knockapi/models/user_list_messages_params.rb

@@ -47,7 +47,7 @@ module Knockapi
       optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -116,7 +116,7 @@ module Knockapi
       #
       #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param source [String] Limits the results to messages triggered by the given workflow key.
       #

data/lib/knockapi/models/user_list_params.rb

@@ -26,7 +26,7 @@ module Knockapi
       optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListParams::Include] }
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -38,7 +38,7 @@ module Knockapi
       #
       #   @param include [Array<Symbol, Knockapi::Models::UserListParams::Include>] Associated resources to include in the response.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/knockapi/models/user_list_schedules_params.rb

@@ -20,7 +20,7 @@ module Knockapi
       optional :before, String
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -42,7 +42,7 @@ module Knockapi
       #
       #   @param before [String] The cursor to fetch entries before.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param tenant [String] The tenant ID to filter schedules for.
       #

data/lib/knockapi/models/user_list_subscriptions_params.rb

@@ -33,7 +33,7 @@ module Knockapi
       optional :objects, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer, nil]
       optional :page_size, Integer
@@ -47,7 +47,7 @@ module Knockapi
       #
       #   @param objects [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Only returns subscriptions for the specified object references.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -33,13 +33,13 @@ module Knockapi
         optional :has_tenant, Knockapi::Internal::Type::Boolean
 
         # @!attribute page_size
-        #   The number of items per page.
+        #   The number of items per page (defaults to 50).
         #
         #   @return [Integer, nil]
         optional :page_size, Integer
 
         # @!attribute source
-        #   The source of the feed items.
+        #   The workflow key associated with the message in the feed.
         #
         #   @return [String, nil]
         optional :source, String
@@ -77,9 +77,9 @@ module Knockapi
         #
         #   @param has_tenant [Boolean] Whether the feed items have a tenant.
         #
-        #   @param page_size [Integer] The number of items per page.
+        #   @param page_size [Integer] The number of items per page (defaults to 50).
         #
-        #   @param source [String] The source of the feed items.
+        #   @param source [String] The workflow key associated with the message in the feed.
         #
         #   @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
         #

data/lib/knockapi/models/workflow_trigger_params.rb

@@ -33,10 +33,10 @@ module Knockapi
       optional :cancellation_key, String, nil?: true
 
       # @!attribute data
-      #   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.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -57,7 +57,7 @@ module Knockapi
       #
       #   @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
       #
-      #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
+      #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
       #   @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #

data/lib/knockapi/resources/messages.rb

@@ -25,7 +25,7 @@ module Knockapi
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
@@ -130,7 +130,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param trigger_data [String] The trigger data to filter activities by.
       #
@@ -161,7 +161,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -190,7 +190,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/knockapi/resources/objects.rb

@@ -19,7 +19,7 @@ module Knockapi
       #
       # @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -221,7 +221,7 @@ module Knockapi
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
@@ -288,7 +288,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param tenant [String] Filter schedules by tenant id.
       #
@@ -334,7 +334,7 @@ module Knockapi
       #
       # @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
       #

data/lib/knockapi/resources/schedules.rb

@@ -23,7 +23,7 @@ module Knockapi
       #
       # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
       #
-      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
       # @param ending_at [Time, nil] The ending date and time for the schedule.
       #
@@ -64,7 +64,7 @@ module Knockapi
       #
       # @param actor [String, Knockapi::Models::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
       #
-      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
       # @param ending_at [Time, nil] The ending date and time for the schedule.
       #
@@ -101,7 +101,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Filter by recipient references.
       #

data/lib/knockapi/resources/tenants.rb

@@ -16,7 +16,7 @@ module Knockapi
       #
       # @param name [String] Filter tenants by name.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param tenant_id [String] Filter tenants by ID.
       #

data/lib/knockapi/resources/users/feeds.rb

@@ -8,7 +8,7 @@ module Knockapi
         #
         # @overload get_settings(user_id, id, request_options: {})
         #
-        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param id [String] The unique identifier for the channel.
         #
@@ -26,12 +26,24 @@ 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.
         #
         # @overload list_items(user_id, id, after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
         #
-        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param id [String] The unique identifier for the channel.
         #
@@ -43,9 +55,9 @@ module Knockapi
         #
         # @param has_tenant [Boolean] Whether the feed items have a tenant.
         #
-        # @param page_size [Integer] The number of items per page.
+        # @param page_size [Integer] The number of items per page (defaults to 50).
         #
-        # @param source [String] The source of the feed items.
+        # @param source [String] The workflow key associated with the message in the feed.
         #
         # @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
         #

data/lib/knockapi/resources/users/guides.rb

@@ -8,7 +8,7 @@ module Knockapi
         #
         # @overload get_channel(user_id, channel_id, data: nil, tenant: nil, type: nil, request_options: {})
         #
-        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param channel_id [String] The unique identifier for the channel.
         #
@@ -39,7 +39,7 @@ module Knockapi
         #
         # @overload mark_message_as_archived(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] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param message_id [String] The unique identifier for the message.
         #
@@ -82,7 +82,7 @@ module Knockapi
         #
         # @overload mark_message_as_interacted(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] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param message_id [String] The unique identifier for the message.
         #
@@ -125,7 +125,7 @@ module Knockapi
         #
         # @overload mark_message_as_seen(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] The ID for the user that you set when identifying them in Knock.
+        # @param user_id [String] The unique identifier of the user.
         #
         # @param message_id [String] The unique identifier for the message.
         #

data/lib/knockapi/resources/users.rb

@@ -21,9 +21,9 @@ module Knockapi
       #
       # @overload update(user_id, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
-      # @param avatar [String, nil] URL to the user's avatar image.
+      # @param avatar [String, nil] A URL for the avatar of the user.
       #
       # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
       #
@@ -68,7 +68,7 @@ module Knockapi
       #
       # @param include [Array<Symbol, Knockapi::Models::UserListParams::Include>] Associated resources to include in the response.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -131,7 +131,7 @@ module Knockapi
       #
       # @overload get_channel_data(user_id, channel_id, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
@@ -154,7 +154,7 @@ module Knockapi
       #
       # @overload get_preferences(user_id, id, tenant: nil, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param id [String] Unique identifier for the preference set.
       #
@@ -179,9 +179,9 @@ module Knockapi
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::UserListMessagesParams} for more details.
       #
-      # 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.
       #
       # @overload list_messages(user_id, after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
       #
@@ -199,7 +199,7 @@ module Knockapi
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
@@ -236,7 +236,7 @@ module Knockapi
       #
       # @overload list_preferences(user_id, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -262,7 +262,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param tenant [String] The tenant ID to filter schedules for.
       #
@@ -300,7 +300,7 @@ module Knockapi
       #
       # @param objects [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Only returns subscriptions for the specified object references.
       #
-      # @param page_size [Integer] The number of items per page.
+      # @param page_size [Integer] The number of items per page (defaults to 50).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -350,7 +350,7 @@ module Knockapi
       #
       # @overload set_channel_data(user_id, channel_id, data:, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
@@ -380,7 +380,7 @@ module Knockapi
       #
       # @overload set_preferences(user_id, id, categories: nil, channel_types: nil, workflows: nil, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param id [String] Unique identifier for the preference set.
       #
@@ -410,7 +410,7 @@ module Knockapi
       #
       # @overload unset_channel_data(user_id, channel_id, request_options: {})
       #
-      # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      # @param user_id [String] The unique identifier of the user.
       #
       # @param channel_id [String] The unique identifier for the channel.
       #

data/lib/knockapi/resources/workflows.rb

@@ -53,7 +53,7 @@ module Knockapi
       #
       # @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
       #
-      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
       #
       # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #

data/lib/knockapi/version.rb

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

data/rbi/knockapi/models/audience_add_members_params.rbi

@@ -98,7 +98,7 @@ module Knockapi
               )
             end
 
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           sig { returns(T.nilable(String)) }
           attr_reader :id
 
@@ -108,7 +108,7 @@ module Knockapi
           # An object containing the user's ID.
           sig { params(id: String).returns(T.attached_class) }
           def self.new(
-            # The ID for the user that you set when identifying them in Knock.
+            # The unique identifier of the user.
             id: nil
           )
           end

data/rbi/knockapi/models/audience_member.rbi

@@ -25,7 +25,7 @@ module Knockapi
       sig { params(user: Knockapi::User::OrHash).void }
       attr_writer :user
 
-      # The ID for the user that you set when identifying them in Knock.
+      # The unique identifier of the user.
       sig { returns(String) }
       attr_accessor :user_id
 
@@ -52,7 +52,7 @@ module Knockapi
         # receive notifications through Knock. Users are the most common recipients of
         # notifications and are always referenced by your internal identifier.
         user:,
-        # 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 tenant.
         tenant: nil

data/rbi/knockapi/models/audience_remove_members_params.rbi

@@ -102,7 +102,7 @@ module Knockapi
               )
             end
 
-          # The ID for the user that you set when identifying them in Knock.
+          # The unique identifier of the user.
           sig { returns(T.nilable(String)) }
           attr_reader :id
 
@@ -112,7 +112,7 @@ module Knockapi
           # An object containing the user's ID.
           sig { params(id: String).returns(T.attached_class) }
           def self.new(
-            # The ID for the user that you set when identifying them in Knock.
+            # The unique identifier of the user.
             id: nil
           )
           end

data/rbi/knockapi/models/identify_user_request.rbi

@@ -8,7 +8,7 @@ module Knockapi
           T.any(Knockapi::IdentifyUserRequest, Knockapi::Internal::AnyHash)
         end
 
-      # URL to the user's avatar image.
+      # A URL for the avatar of the user.
       sig { returns(T.nilable(String)) }
       attr_accessor :avatar
 
@@ -104,7 +104,7 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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,

data/rbi/knockapi/models/inline_identify_user_request.rbi

@@ -11,11 +11,11 @@ module Knockapi
           )
         end
 
-      # The ID for the user that you set when identifying them in Knock.
+      # The unique identifier of the user.
       sig { returns(String) }
       attr_accessor :id
 
-      # URL to the user's avatar image.
+      # A URL for the avatar of the user.
       sig { returns(T.nilable(String)) }
       attr_accessor :avatar
 
@@ -113,9 +113,9 @@ module Knockapi
         ).returns(T.attached_class)
       end
       def self.new(
-        # The ID for the user that you set when identifying them in Knock.
+        # The unique identifier of the 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,