RubyGems - knockapi - Versions diffs - 1.1.0 → 1.3.0 - Mend

knockapi 1.1.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (307) hide show

data/lib/knockapi/resources/objects.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/knockapi/resources/users.rb CHANGED Viewed

@@ -25,7 +25,7 @@ module Knockapi
       #
       # @param avatar [String, nil] URL to the user's avatar image.
       #
-      # @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 created_at [Time, nil] The creation date of the user from your system.
       #
@@ -37,13 +37,13 @@ module Knockapi
       #
       # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
       #
-      # @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 timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::User]
+      # @return [Knockapi::Models::User]
       #
       # @see Knockapi::Models::UserUpdateParams
       def update(user_id, params = {})
@@ -66,13 +66,13 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param include [Array<Symbol, Knockapi::UserListParams::Include>] Associated resources to include in the response.
+      # @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 request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::User>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::User>]
       #
       # @see Knockapi::Models::UserListParams
       def list(params = {})
@@ -115,7 +115,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::User]
+      # @return [Knockapi::Models::User]
       #
       # @see Knockapi::Models::UserGetParams
       def get(user_id, params = {})
@@ -137,7 +137,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::RecipientsChannelData]
+      # @return [Knockapi::Models::Recipients::RecipientsChannelData]
       #
       # @see Knockapi::Models::UserGetChannelDataParams
       def get_channel_data(user_id, channel_id, params = {})
@@ -162,7 +162,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Recipients::PreferenceSet]
+      # @return [Knockapi::Models::Recipients::PreferenceSet]
       #
       # @see Knockapi::Models::UserGetPreferencesParams
       def get_preferences(user_id, id, params = {})
@@ -193,9 +193,9 @@ module Knockapi
       #
       # @param channel_id [String] Limits the results to items with the corresponding channel ID.
       #
-      # @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      # @param engagement_status [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
       #
-      # @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
+      # @param inserted_at [Knockapi::Models::UserListMessagesParams::InsertedAt]
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
       #
@@ -203,7 +203,7 @@ module Knockapi
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
-      # @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
+      # @param status [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
       #
       # @param tenant [String] Limits the results to items with the corresponding tenant.
       #
@@ -217,7 +217,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::UserListMessagesParams
       def list_messages(user_id, params = {})
@@ -226,7 +226,7 @@ module Knockapi
           method: :get,
           path: ["v1/users/%1$s/messages", user_id],
           query: parsed,
-          page: Knockapi::Internal::EntriesCursor,
+          page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
         )
@@ -240,7 +240,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::UserListPreferencesParams
       def list_preferences(user_id, params = {})
@@ -270,7 +270,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::UserListSchedulesParams
       def list_schedules(user_id, params = {})
@@ -296,7 +296,7 @@ module Knockapi
       #
       # @param before [String] The cursor to fetch entries before.
       #
-      # @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
+      # @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
       #
       # @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
       #
@@ -304,7 +304,7 @@ module Knockapi
       #
       # @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::UserListSubscriptionsParams
       def list_subscriptions(user_id, params = {})
@@ -330,7 +330,7 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::User]
+      # @return [Knockapi::Models::User]
       #
       # @see Knockapi::Models::UserMergeParams
       def merge(user_id, params)
@@ -352,11 +352,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::UserSetChannelDataParams
       def set_channel_data(user_id, channel_id, params)
@@ -382,15 +382,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::UserSetPreferencesParams
       def set_preferences(user_id, id, params = {})