knockapi 1.2.0 → 1.3.0

data/lib/knockapi/resources/messages.rb

@@ -19,9 +19,9 @@ module Knockapi
       #
       # @param channel_id [String] Limits the results to items with the corresponding channel ID.
       #
-      # @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      # @param engagement_status [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
       #
-      # @param inserted_at [Knockapi::MessageListParams::InsertedAt]
+      # @param inserted_at [Knockapi::Models::MessageListParams::InsertedAt]
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
@@ -29,7 +29,7 @@ module Knockapi
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
-      # @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
+      # @param status [Array<Symbol, Knockapi::Models::MessageListParams::Status>] Limits the results to messages with the given delivery status.
       #
       # @param tenant [String] Limits the results to items with the corresponding tenant.
       #
@@ -43,7 +43,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Message>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Message>]
       #
       # @see Knockapi::Models::MessageListParams
       def list(params = {})
@@ -52,7 +52,7 @@ module Knockapi
           method: :get,
           path: "v1/messages",
           query: parsed,
-          page: Knockapi::Internal::EntriesCursor,
+          page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
         )
@@ -67,7 +67,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageArchiveParams
       def archive(message_id, params = {})
@@ -87,7 +87,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageGetParams
       def get(message_id, params = {})
@@ -136,7 +136,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Activity>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Activity>]
       #
       # @see Knockapi::Models::MessageListActivitiesParams
       def list_activities(message_id, params = {})
@@ -165,7 +165,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::MessageDeliveryLog>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::MessageDeliveryLog>]
       #
       # @see Knockapi::Models::MessageListDeliveryLogsParams
       def list_delivery_logs(message_id, params = {})
@@ -174,7 +174,7 @@ module Knockapi
           method: :get,
           path: ["v1/messages/%1$s/delivery_logs", message_id],
           query: parsed,
-          page: Knockapi::Internal::EntriesCursor,
+          page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::MessageDeliveryLog,
           options: options
         )
@@ -194,7 +194,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::MessageEvent>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::MessageEvent>]
       #
       # @see Knockapi::Models::MessageListEventsParams
       def list_events(message_id, params = {})
@@ -203,7 +203,7 @@ module Knockapi
           method: :get,
           path: ["v1/messages/%1$s/events", message_id],
           query: parsed,
-          page: Knockapi::Internal::EntriesCursor,
+          page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::MessageEvent,
           options: options
         )
@@ -223,7 +223,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageMarkAsInteractedParams
       def mark_as_interacted(message_id, params = {})
@@ -247,7 +247,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageMarkAsReadParams
       def mark_as_read(message_id, params = {})
@@ -269,7 +269,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageMarkAsSeenParams
       def mark_as_seen(message_id, params = {})
@@ -291,7 +291,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageMarkAsUnreadParams
       def mark_as_unread(message_id, params = {})
@@ -313,7 +313,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageMarkAsUnseenParams
       def mark_as_unseen(message_id, params = {})
@@ -334,7 +334,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Message]
+      # @return [Knockapi::Models::Message]
       #
       # @see Knockapi::Models::MessageUnarchiveParams
       def unarchive(message_id, params = {})

data/lib/knockapi/resources/objects/bulk.rb

@@ -14,7 +14,7 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkDeleteParams
         def delete(collection, params)
@@ -38,11 +38,11 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
+        # @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkAddSubscriptionsParams
         def add_subscriptions(collection, params)
@@ -62,11 +62,11 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
+        # @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkSetParams
         def set(collection, params)

data/lib/knockapi/resources/objects.rb

@@ -17,13 +17,13 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param include [Array<Symbol, Knockapi::ObjectListParams::Include>] Includes preferences of the objects in the response.
+      # @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 request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Object>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Object>]
       #
       # @see Knockapi::Models::ObjectListParams
       def list(collection, params = {})
@@ -75,13 +75,13 @@ module Knockapi
       #
       # @param object_id_ [String] Unique identifier for the object.
       #
-      # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+      # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
       #
       # @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Recipients::Subscription>]
+      # @return [Array<Knockapi::Models::Recipients::Subscription>]
       #
       # @see Knockapi::Models::ObjectAddSubscriptionsParams
       def add_subscriptions(collection, object_id_, params)
@@ -107,11 +107,11 @@ module Knockapi
       #
       # @param object_id_ [String] Unique identifier for the object.
       #
-      # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+      # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Recipients::Subscription>]
+      # @return [Array<Knockapi::Models::Recipients::Subscription>]
       #
       # @see Knockapi::Models::ObjectDeleteSubscriptionsParams
       def delete_subscriptions(collection, object_id_, params)
@@ -136,7 +136,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Object]
+      # @return [Knockapi::Models::Object]
       #
       # @see Knockapi::Models::ObjectGetParams
       def get(collection, id, params = {})
@@ -160,7 +160,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::RecipientsChannelData]
+      # @return [Knockapi::Models::Recipients::RecipientsChannelData]
       #
       # @see Knockapi::Models::ObjectGetChannelDataParams
       def get_channel_data(collection, object_id_, channel_id, params = {})
@@ -184,7 +184,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::PreferenceSet]
+      # @return [Knockapi::Models::Recipients::PreferenceSet]
       #
       # @see Knockapi::Models::ObjectGetPreferencesParams
       def get_preferences(collection, object_id_, id, params = {})
@@ -215,9 +215,9 @@ module Knockapi
       #
       # @param channel_id [String] Limits the results to items with the corresponding channel ID.
       #
-      # @param engagement_status [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      # @param engagement_status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
       #
-      # @param inserted_at [Knockapi::ObjectListMessagesParams::InsertedAt]
+      # @param inserted_at [Knockapi::Models::ObjectListMessagesParams::InsertedAt]
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
@@ -225,7 +225,7 @@ module Knockapi
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
-      # @param status [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
+      # @param status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
       #
       # @param tenant [String] Limits the results to items with the corresponding tenant.
       #
@@ -239,7 +239,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Message>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Message>]
       #
       # @see Knockapi::Models::ObjectListMessagesParams
       def list_messages(collection, id, params = {})
@@ -248,7 +248,7 @@ module Knockapi
           method: :get,
           path: ["v1/objects/%1$s/%2$s/messages", collection, id],
           query: parsed,
-          page: Knockapi::Internal::EntriesCursor,
+          page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
         )
@@ -264,7 +264,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Recipients::PreferenceSet>]
+      # @return [Array<Knockapi::Models::Recipients::PreferenceSet>]
       #
       # @see Knockapi::Models::ObjectListPreferencesParams
       def list_preferences(collection, object_id_, params = {})
@@ -296,7 +296,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
       #
       # @see Knockapi::Models::ObjectListSchedulesParams
       def list_schedules(collection, id, params = {})
@@ -328,19 +328,19 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param include [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
+      # @param include [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
       #
-      # @param mode [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
+      # @param mode [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
       #
-      # @param objects [Array<Knockapi::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
+      # @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 recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
+      # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Recipients::Subscription>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Recipients::Subscription>]
       #
       # @see Knockapi::Models::ObjectListSubscriptionsParams
       def list_subscriptions(collection, object_id_, params = {})
@@ -368,17 +368,17 @@ module Knockapi
       #
       # @param id [String] Unique identifier for the object.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
+      # @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}] A request to set channel data for a type of channel inline.
       #
       # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
       #
-      # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
+      # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
       #
       # @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Object]
+      # @return [Knockapi::Models::Object]
       #
       # @see Knockapi::Models::ObjectSetParams
       def set(collection, id, params = {})
@@ -404,11 +404,11 @@ module Knockapi
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
-      # @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
+      # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::RecipientsChannelData]
+      # @return [Knockapi::Models::Recipients::RecipientsChannelData]
       #
       # @see Knockapi::Models::ObjectSetChannelDataParams
       def set_channel_data(collection, object_id_, channel_id, params)
@@ -440,15 +440,15 @@ module Knockapi
       #
       # @param id [String] Unique identifier for the preference set.
       #
-      # @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
+      # @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
       #
-      # @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+      # @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
       #
-      # @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
+      # @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::PreferenceSet]
+      # @return [Knockapi::Models::Recipients::PreferenceSet]
       #
       # @see Knockapi::Models::ObjectSetPreferencesParams
       def set_preferences(collection, object_id_, id, params = {})

data/lib/knockapi/resources/providers/ms_teams.rb

@@ -40,7 +40,7 @@ module Knockapi
         #
         # @param team_id [String] Microsoft Teams team ID.
         #
-        # @param query_options [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions]
+        # @param query_options [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions]
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -67,7 +67,7 @@ module Knockapi
         #
         # @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
         #
-        # @param query_options [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions]
+        # @param query_options [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions]
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/knockapi/resources/providers/slack.rb

@@ -36,7 +36,7 @@ module Knockapi
         #
         # @param access_token_object [String] A JSON encoded string containing the access token object reference.
         #
-        # @param query_options [Knockapi::Providers::SlackListChannelsParams::QueryOptions]
+        # @param query_options [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions]
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/knockapi/resources/schedules/bulk.rb

@@ -10,11 +10,11 @@ module Knockapi
         #
         # @overload create(schedules:, request_options: {})
         #
-        # @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
+        # @param schedules [Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>] A list of schedules.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Schedules::BulkCreateParams
         def create(params)

data/lib/knockapi/resources/schedules.rb

@@ -6,6 +6,9 @@ module Knockapi
       # @return [Knockapi::Resources::Schedules::Bulk]
       attr_reader :bulk
 
+      # Some parameter documentations has been truncated, see
+      # {Knockapi::Models::ScheduleCreateParams} for more details.
+      #
       # Creates one or more schedules for a workflow with the specified recipients,
       # timing, and data. Schedules can be one-time or recurring. This endpoint also
       # handles
@@ -14,23 +17,23 @@ module Knockapi
       #
       # @overload create(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
       #
-      # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
+      # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
       #
-      # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
       #
       # @param workflow [String] The key of the workflow.
       #
-      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
       #
       # @param ending_at [Time, nil] The ending date and time for the schedule.
       #
       # @param scheduled_at [Time, nil] The starting date and time for the schedule.
       #
-      # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Schedule>]
+      # @return [Array<Knockapi::Models::Schedule>]
       #
       # @see Knockapi::Models::ScheduleCreateParams
       def create(params)
@@ -57,21 +60,21 @@ module Knockapi
       #
       # @param schedule_ids [Array<String>] A list of schedule IDs.
       #
-      # @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
+      # @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.
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
       #
       # @param ending_at [Time, nil] The ending date and time for the schedule.
       #
-      # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
       #
       # @param scheduled_at [Time, nil] The starting date and time for the schedule.
       #
-      # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Schedule>]
+      # @return [Array<Knockapi::Models::Schedule>]
       #
       # @see Knockapi::Models::ScheduleUpdateParams
       def update(params)
@@ -104,7 +107,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
       #
       # @see Knockapi::Models::ScheduleListParams
       def list(params)
@@ -128,7 +131,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<Knockapi::Schedule>]
+      # @return [Array<Knockapi::Models::Schedule>]
       #
       # @see Knockapi::Models::ScheduleDeleteParams
       def delete(params)

data/lib/knockapi/resources/tenants/bulk.rb

@@ -12,7 +12,7 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Tenants::BulkDeleteParams
         def delete(params)
@@ -30,11 +30,11 @@ module Knockapi
         #
         # @overload set(tenants:, request_options: {})
         #
-        # @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
+        # @param tenants [Array<String, Knockapi::Models::TenantRequest>] The tenants to be upserted.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Tenants::BulkSetParams
         def set(params)

data/lib/knockapi/resources/tenants.rb

@@ -22,7 +22,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Tenant>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Tenant>]
       #
       # @see Knockapi::Models::TenantListParams
       def list(params = {})
@@ -65,7 +65,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Tenant]
+      # @return [Knockapi::Models::Tenant]
       #
       # @see Knockapi::Models::TenantGetParams
       def get(id, params = {})
@@ -84,15 +84,15 @@ module Knockapi
       #
       # @param id [String] The unique identifier for the tenant.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      # @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.
       #
-      # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
       #
-      # @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Tenant]
+      # @return [Knockapi::Models::Tenant]
       #
       # @see Knockapi::Models::TenantSetParams
       def set(id, params = {})

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

@@ -13,7 +13,7 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Users::BulkDeleteParams
         def delete(params)
@@ -33,11 +33,11 @@ module Knockapi
         #
         # @overload identify(users:, request_options: {})
         #
-        # @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
+        # @param users [Array<Knockapi::Models::InlineIdentifyUserRequest>] A list of users.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Users::BulkIdentifyParams
         def identify(params)
@@ -57,13 +57,13 @@ module Knockapi
         #
         # @overload set_preferences(preferences:, user_ids:, request_options: {})
         #
-        # @param preferences [Knockapi::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
+        # @param preferences [Knockapi::Models::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
         #
         # @param user_ids [Array<String>] A list of user IDs.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::BulkOperation]
+        # @return [Knockapi::Models::BulkOperation]
         #
         # @see Knockapi::Models::Users::BulkSetPreferencesParams
         def set_preferences(params)

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

@@ -37,7 +37,7 @@ module Knockapi
         #
         # @param after [String] The cursor to fetch entries after.
         #
-        # @param archived [Symbol, Knockapi::Users::FeedListItemsParams::Archived] The archived status of the feed items.
+        # @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
         #
         # @param before [String] The cursor to fetch entries before.
         #
@@ -47,7 +47,7 @@ module Knockapi
         #
         # @param source [String] The source of the feed items.
         #
-        # @param status [Symbol, Knockapi::Users::FeedListItemsParams::Status] The status of the feed items.
+        # @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
         #
         # @param tenant [String] The tenant associated with the feed items.
         #