knockapi 1.8.0 → 1.9.0

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -44,7 +44,7 @@ module Knockapi
         # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
         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, nil]
           optional :id, String
@@ -52,7 +52,7 @@ module Knockapi
           # @!method initialize(id: nil)
           #   An object containing the user's ID.
           #
-          #   @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.
         end
       end
     end

data/lib/knockapi/models/identify_user_request.rb

@@ -4,7 +4,7 @@ module Knockapi
   module Models
     class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
       # @!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
@@ -77,7 +77,7 @@ module Knockapi
       #   that's specified elsewhere in the request. You can supply any additional
       #   properties you'd like to upsert for 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.
       #

data/lib/knockapi/models/inline_identify_user_request.rb

@@ -4,13 +4,13 @@ module Knockapi
   module Models
     class InlineIdentifyUserRequest < 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
 
       # @!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
@@ -84,9 +84,9 @@ module Knockapi
       #   It will perform an upsert for the user you're supplying, replacing any
       #   properties specified.
       #
-      #   @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 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.
       #

data/lib/knockapi/models/message.rb

@@ -230,7 +230,13 @@ module Knockapi
         #   @return [String]
         required :version_id, String
 
-        # @!method initialize(_typename:, categories:, key:, version_id:)
+        # @!attribute step_ref
+        #   The step reference for the step in the workflow that generated the message
+        #
+        #   @return [String, nil]
+        optional :step_ref, String, nil?: true
+
+        # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil)
         #   The workflow that triggered the message.
         #
         #   @param _typename [String]
@@ -240,6 +246,8 @@ module Knockapi
         #   @param key [String] The key of the workflow that triggered the message.
         #
         #   @param version_id [String] The ID of the version of the workflow that triggered the message.
+        #
+        #   @param step_ref [String, nil] The step reference for the step in the workflow that generated the message
       end
 
       # The message delivery status.

data/lib/knockapi/models/message_get_content_response.rb

@@ -51,7 +51,7 @@ module Knockapi
         # The content of an SMS message.
         variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent }
 
-        # The content of a push notification.
+        # Push channel data.
         variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent }
 
         # The content of a chat message.
@@ -198,7 +198,7 @@ module Knockapi
           optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
           # @!method initialize(token:, _typename:, body:, title:, data: nil)
-          #   The content of a push notification.
+          #   Push channel data.
           #
           #   @param token [String] The device token to send the push notification to.
           #

data/lib/knockapi/models/message_list_activities_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
@@ -36,7 +36,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.
       #

data/lib/knockapi/models/message_list_delivery_logs_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
@@ -30,7 +30,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}]
     end

data/lib/knockapi/models/message_list_events_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
@@ -30,7 +30,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}]
     end

data/lib/knockapi/models/message_list_params.rb

@@ -45,7 +45,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
@@ -111,7 +111,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/messages/batch_get_content_response.rb

@@ -51,7 +51,7 @@ module Knockapi
           # The content of an SMS message.
           variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent }
 
-          # The content of a push notification.
+          # Push channel data.
           variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent }
 
           # The content of a chat message.
@@ -198,7 +198,7 @@ module Knockapi
             optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
 
             # @!method initialize(token:, _typename:, body:, title:, data: nil)
-            #   The content of a push notification.
+            #   Push channel data.
             #
             #   @param token [String] The device token to send the push notification to.
             #

data/lib/knockapi/models/object_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
@@ -114,7 +114,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/object_list_params.rb

@@ -26,7 +26,7 @@ module Knockapi
       optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::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::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}]
 

data/lib/knockapi/models/object_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] Filter schedules by tenant id.
       #

data/lib/knockapi/models/object_list_subscriptions_params.rb

@@ -44,7 +44,7 @@ module Knockapi
                -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
 
       # @!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
@@ -69,7 +69,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/models/page_info.rb

@@ -10,7 +10,7 @@ module Knockapi
       required :_typename, String, api_name: :__typename
 
       # @!attribute page_size
-      #   The number of items per page.
+      #   The number of items per page (defaults to 50).
       #
       #   @return [Integer]
       required :page_size, Integer
@@ -32,7 +32,7 @@ module Knockapi
       #
       #   @param _typename [String] The typename of the schema.
       #
-      #   @param page_size [Integer] The number of items per page.
+      #   @param page_size [Integer] The number of items per page (defaults to 50).
       #
       #   @param after [String, nil] The cursor to fetch entries after.
       #

data/lib/knockapi/models/recipients/channel_data.rb

@@ -45,13 +45,13 @@ module Knockapi
         module Data
           extend Knockapi::Internal::Type::Union
 
-          # The content of a push notification.
+          # Push channel data.
           variant -> { Knockapi::Recipients::PushChannelData }
 
-          # Slack channel data
+          # Slack channel data.
           variant -> { Knockapi::Recipients::SlackChannelData }
 
-          # Microsoft Teams channel connection.
+          # Microsoft Teams channel data.
           variant -> { Knockapi::Recipients::MsTeamsChannelData }
 
           # Discord channel data.

data/lib/knockapi/models/recipients/channel_data_request.rb

@@ -21,16 +21,16 @@ module Knockapi
         module Data
           extend Knockapi::Internal::Type::Union
 
-          # The content of a push notification.
+          # Push channel data.
           variant -> { Knockapi::Recipients::PushChannelData }
 
           # OneSignal channel data.
           variant -> { Knockapi::Recipients::OneSignalChannelData }
 
-          # Slack channel data
+          # Slack channel data.
           variant -> { Knockapi::Recipients::SlackChannelData }
 
-          # Microsoft Teams channel connection.
+          # Microsoft Teams channel data.
           variant -> { Knockapi::Recipients::MsTeamsChannelData }
 
           # Discord channel data.

data/lib/knockapi/models/recipients/inline_channel_data_request.rb

@@ -7,16 +7,16 @@ module Knockapi
       module InlineChannelDataRequestItem
         extend Knockapi::Internal::Type::Union
 
-        # The content of a push notification.
+        # Push channel data.
         variant -> { Knockapi::Recipients::PushChannelData }
 
         # OneSignal channel data.
         variant -> { Knockapi::Recipients::OneSignalChannelData }
 
-        # Slack channel data
+        # Slack channel data.
         variant -> { Knockapi::Recipients::SlackChannelData }
 
-        # Microsoft Teams channel connection.
+        # Microsoft Teams channel data.
         variant -> { Knockapi::Recipients::MsTeamsChannelData }
 
         # Discord channel data.

data/lib/knockapi/models/recipients/ms_teams_channel_data.rb

@@ -20,7 +20,7 @@ module Knockapi
         optional :ms_teams_tenant_id, String, nil?: true
 
         # @!method initialize(connections:, ms_teams_tenant_id: nil)
-        #   Microsoft Teams channel connection.
+        #   Microsoft Teams channel data.
         #
         #   @param connections [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
         #

data/lib/knockapi/models/recipients/push_channel_data.rb

@@ -11,7 +11,7 @@ module Knockapi
         required :tokens, Knockapi::Internal::Type::ArrayOf[String]
 
         # @!method initialize(tokens:)
-        #   The content of a push notification.
+        #   Push channel data.
         #
         #   @param tokens [Array<String>] A list of push channel tokens.
       end

data/lib/knockapi/models/recipients/slack_channel_data.rb

@@ -20,7 +20,7 @@ module Knockapi
         optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
 
         # @!method initialize(connections:, token: nil)
-        #   Slack channel data
+        #   Slack channel data.
         #
         #   @param connections [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
         #

data/lib/knockapi/models/schedule_list_params.rb

@@ -26,7 +26,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
@@ -50,7 +50,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/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/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

@@ -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.
       #