knockapi 1.1.0 → 1.3.0

data/lib/knockapi/models/schedule_create_params.rb

@@ -10,13 +10,13 @@ module Knockapi
       # @!attribute recipients
       #   The recipients to set the schedule for. Limited to 100 recipients per request.
       #
-      #   @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
+      #   @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
       required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
 
       # @!attribute repeats
       #   The repeat rule for the schedule.
       #
-      #   @return [Array<Knockapi::ScheduleRepeatRule>]
+      #   @return [Array<Knockapi::Models::ScheduleRepeatRule>]
       required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
 
       # @!attribute workflow
@@ -26,7 +26,10 @@ module Knockapi
       required :workflow, String
 
       # @!attribute data
-      #   An optional map of data to pass into the workflow execution.
+      #   An optional map of data to pass into the workflow execution. There is a 1024
+      #   byte limit on the size of any single string value (with the exception of
+      #   [email attachments](/integrations/email/attachments)), and a 10MB limit on the
+      #   size of the full `data` payload.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -46,23 +49,26 @@ module Knockapi
       # @!attribute tenant
       #   An request to set a tenant inline.
       #
-      #   @return [String, Knockapi::TenantRequest, nil]
+      #   @return [String, Knockapi::Models::TenantRequest, nil]
       optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
 
       # @!method initialize(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.
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ScheduleCreateParams} for more details.
       #
-      #   @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #   @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::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}]
     end

data/lib/knockapi/models/schedule_repeat_rule.rb

@@ -12,7 +12,7 @@ module Knockapi
       # @!attribute frequency
       #   The frequency of the schedule.
       #
-      #   @return [Symbol, Knockapi::ScheduleRepeatRule::Frequency]
+      #   @return [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency]
       required :frequency, enum: -> { Knockapi::ScheduleRepeatRule::Frequency }
 
       # @!attribute day_of_month
@@ -24,7 +24,7 @@ module Knockapi
       # @!attribute days
       #   The days of the week to repeat the schedule.
       #
-      #   @return [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil]
+      #   @return [Array<Symbol, Knockapi::Models::ScheduleRepeatRule::Day>, nil]
       optional :days,
                -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ScheduleRepeatRule::Day] },
                nil?: true
@@ -52,11 +52,11 @@ module Knockapi
       #
       #   @param _typename [String] The typename of the schema.
       #
-      #   @param frequency [Symbol, Knockapi::ScheduleRepeatRule::Frequency] The frequency of the schedule.
+      #   @param frequency [Symbol, Knockapi::Models::ScheduleRepeatRule::Frequency] The frequency of the schedule.
       #
       #   @param day_of_month [Integer, nil] The day of the month to repeat the schedule.
       #
-      #   @param days [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
+      #   @param days [Array<Symbol, Knockapi::Models::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
       #
       #   @param hours [Integer, nil] The hour of the day to repeat the schedule.
       #
@@ -66,7 +66,7 @@ module Knockapi
 
       # The frequency of the schedule.
       #
-      # @see Knockapi::ScheduleRepeatRule#frequency
+      # @see Knockapi::Models::ScheduleRepeatRule#frequency
       module Frequency
         extend Knockapi::Internal::Type::Enum
 

data/lib/knockapi/models/schedule_update_params.rb

@@ -17,11 +17,14 @@ module Knockapi
       #   A reference to a recipient, either a user identifier (string) or an object
       #   reference (ID, collection).
       #
-      #   @return [String, Knockapi::RecipientReference::ObjectReference, nil]
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
       optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true
 
       # @!attribute data
-      #   An optional map of data to pass into the workflow execution.
+      #   An optional map of data to pass into the workflow execution. There is a 1024
+      #   byte limit on the size of any single string value (with the exception of
+      #   [email attachments](/integrations/email/attachments)), and a 10MB limit on the
+      #   size of the full `data` payload.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -35,7 +38,7 @@ module Knockapi
       # @!attribute repeats
       #   The repeat rule for the schedule.
       #
-      #   @return [Array<Knockapi::ScheduleRepeatRule>, nil]
+      #   @return [Array<Knockapi::Models::ScheduleRepeatRule>, nil]
       optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
 
       # @!attribute scheduled_at
@@ -47,7 +50,7 @@ module Knockapi
       # @!attribute tenant
       #   An request to set a tenant inline.
       #
-      #   @return [String, Knockapi::TenantRequest, nil]
+      #   @return [String, Knockapi::Models::TenantRequest, nil]
       optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
 
       # @!method initialize(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
@@ -56,17 +59,17 @@ 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}]
     end

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

@@ -11,12 +11,12 @@ module Knockapi
         # @!attribute schedules
         #   A list of schedules.
         #
-        #   @return [Array<Knockapi::Schedules::BulkCreateParams::Schedule>]
+        #   @return [Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>]
         required :schedules,
                  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Schedules::BulkCreateParams::Schedule] }
 
         # @!method initialize(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}]
 
@@ -32,11 +32,14 @@ module Knockapi
           #   (string), an inline user request (object), or an inline object request, which is
           #   determined by the presence of a `collection` property.
           #
-          #   @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
+          #   @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
           optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
 
           # @!attribute data
-          #   An optional map of data to pass into the workflow execution.
+          #   An optional map of data to pass into the workflow execution. There is a 1024
+          #   byte limit on the size of any single string value (with the exception of
+          #   [email attachments](/integrations/email/attachments)), and a 10MB limit on the
+          #   size of the full `data` payload.
           #
           #   @return [Hash{Symbol=>Object}, nil]
           optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -52,13 +55,13 @@ module Knockapi
           #   (string), an inline user request (object), or an inline object request, which is
           #   determined by the presence of a `collection` property.
           #
-          #   @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
+          #   @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
           optional :recipient, union: -> { Knockapi::RecipientRequest }
 
           # @!attribute repeats
           #   The repeat rule for the schedule.
           #
-          #   @return [Array<Knockapi::ScheduleRepeatRule>, nil]
+          #   @return [Array<Knockapi::Models::ScheduleRepeatRule>, nil]
           optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
 
           # @!attribute scheduled_at
@@ -70,30 +73,30 @@ module Knockapi
           # @!attribute tenant
           #   An request to set a tenant inline.
           #
-          #   @return [String, Knockapi::TenantRequest, nil]
+          #   @return [String, Knockapi::Models::TenantRequest, nil]
           optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
 
           # @!method initialize(workflow:, actor: nil, data: nil, ending_at: nil, recipient: nil, repeats: nil, scheduled_at: nil, tenant: nil)
           #   Some parameter documentations has been truncated, see
-          #   {Knockapi::Schedules::BulkCreateParams::Schedule} for more details.
+          #   {Knockapi::Models::Schedules::BulkCreateParams::Schedule} for more details.
           #
           #   A schedule represents a recurring workflow execution.
           #
           #   @param workflow [String] The key of the workflow.
           #
-          #   @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
+          #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
           #
-          #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+          #   @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 recipient [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
+          #   @param recipient [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
           #
-          #   @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.
         end
       end
     end

data/lib/knockapi/models/tenant.rb

@@ -25,7 +25,7 @@ module Knockapi
       # @!attribute settings
       #   The settings for the tenant. Includes branding and preference set.
       #
-      #   @return [Knockapi::Tenant::Settings, nil]
+      #   @return [Knockapi::Models::Tenant::Settings, nil]
       optional :settings, -> { Knockapi::Tenant::Settings }, nil?: true
 
       # @!method initialize(id:, _typename:, name: nil, settings: nil)
@@ -37,34 +37,34 @@ module Knockapi
       #
       #   @param name [String, nil] An optional name for the tenant.
       #
-      #   @param settings [Knockapi::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
+      #   @param settings [Knockapi::Models::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
 
-      # @see Knockapi::Tenant#settings
+      # @see Knockapi::Models::Tenant#settings
       class Settings < Knockapi::Internal::Type::BaseModel
         # @!attribute branding
         #   The branding for the tenant.
         #
-        #   @return [Knockapi::Tenant::Settings::Branding, nil]
+        #   @return [Knockapi::Models::Tenant::Settings::Branding, nil]
         optional :branding, -> { Knockapi::Tenant::Settings::Branding }, nil?: true
 
         # @!attribute preference_set
         #   A preference set represents a specific set of notification preferences for a
         #   recipient. A recipient can have multiple preference sets.
         #
-        #   @return [Knockapi::Recipients::PreferenceSet, nil]
+        #   @return [Knockapi::Models::Recipients::PreferenceSet, nil]
         optional :preference_set, -> { Knockapi::Recipients::PreferenceSet }, nil?: true
 
         # @!method initialize(branding: nil, preference_set: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Knockapi::Tenant::Settings} for more details.
+        #   {Knockapi::Models::Tenant::Settings} for more details.
         #
         #   The settings for the tenant. Includes branding and preference set.
         #
-        #   @param branding [Knockapi::Tenant::Settings::Branding, nil] The branding for the tenant.
+        #   @param branding [Knockapi::Models::Tenant::Settings::Branding, nil] The branding for the tenant.
         #
-        #   @param preference_set [Knockapi::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
 
-        # @see Knockapi::Tenant::Settings#branding
+        # @see Knockapi::Models::Tenant::Settings#branding
         class Branding < Knockapi::Internal::Type::BaseModel
           # @!attribute icon_url
           #   The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -94,7 +94,7 @@ module Knockapi
 
           # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
           #   Some parameter documentations has been truncated, see
-          #   {Knockapi::Tenant::Settings::Branding} for more details.
+          #   {Knockapi::Models::Tenant::Settings::Branding} for more details.
           #
           #   The branding for the tenant.
           #

data/lib/knockapi/models/tenant_request.rb

@@ -12,7 +12,7 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -22,7 +22,7 @@ module Knockapi
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
@@ -30,7 +30,7 @@ module Knockapi
       # @!attribute settings
       #   The settings for the tenant. Includes branding and preference set.
       #
-      #   @return [Knockapi::TenantRequest::Settings, nil]
+      #   @return [Knockapi::Models::TenantRequest::Settings, nil]
       optional :settings, -> { Knockapi::TenantRequest::Settings }
 
       # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
@@ -39,34 +39,34 @@ 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::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
+      #   @param settings [Knockapi::Models::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
 
-      # @see Knockapi::TenantRequest#settings
+      # @see Knockapi::Models::TenantRequest#settings
       class Settings < Knockapi::Internal::Type::BaseModel
         # @!attribute branding
         #   The branding for the tenant.
         #
-        #   @return [Knockapi::TenantRequest::Settings::Branding, nil]
+        #   @return [Knockapi::Models::TenantRequest::Settings::Branding, nil]
         optional :branding, -> { Knockapi::TenantRequest::Settings::Branding }
 
         # @!attribute preference_set
         #   A request to set a preference set for a recipient.
         #
-        #   @return [Knockapi::Recipients::PreferenceSetRequest, nil]
+        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
         optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
 
         # @!method initialize(branding: nil, preference_set: nil)
         #   The settings for the tenant. Includes branding and preference set.
         #
-        #   @param branding [Knockapi::TenantRequest::Settings::Branding] The branding for the tenant.
+        #   @param branding [Knockapi::Models::TenantRequest::Settings::Branding] The branding for the tenant.
         #
-        #   @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
 
-        # @see Knockapi::TenantRequest::Settings#branding
+        # @see Knockapi::Models::TenantRequest::Settings#branding
         class Branding < Knockapi::Internal::Type::BaseModel
           # @!attribute icon_url
           #   The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -96,7 +96,7 @@ module Knockapi
 
           # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
           #   Some parameter documentations has been truncated, see
-          #   {Knockapi::TenantRequest::Settings::Branding} for more details.
+          #   {Knockapi::Models::TenantRequest::Settings::Branding} for more details.
           #
           #   The branding for the tenant.
           #

data/lib/knockapi/models/tenant_set_params.rb

@@ -10,7 +10,7 @@ module Knockapi
       # @!attribute channel_data
       #   A request to set channel data for a type of channel inline.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -20,7 +20,7 @@ module Knockapi
       # @!attribute preferences
       #   Inline set preferences for a recipient, where the key is the preference set id.
       #
-      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
       optional :preferences,
                -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
                nil?: true
@@ -28,15 +28,15 @@ module Knockapi
       # @!attribute settings
       #   The settings for the tenant. Includes branding and preference set.
       #
-      #   @return [Knockapi::TenantSetParams::Settings, nil]
+      #   @return [Knockapi::Models::TenantSetParams::Settings, nil]
       optional :settings, -> { Knockapi::TenantSetParams::Settings }
 
       # @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
-      #   @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}]
 
@@ -44,23 +44,23 @@ module Knockapi
         # @!attribute branding
         #   The branding for the tenant.
         #
-        #   @return [Knockapi::TenantSetParams::Settings::Branding, nil]
+        #   @return [Knockapi::Models::TenantSetParams::Settings::Branding, nil]
         optional :branding, -> { Knockapi::TenantSetParams::Settings::Branding }
 
         # @!attribute preference_set
         #   A request to set a preference set for a recipient.
         #
-        #   @return [Knockapi::Recipients::PreferenceSetRequest, nil]
+        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
         optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
 
         # @!method initialize(branding: nil, preference_set: nil)
         #   The settings for the tenant. Includes branding and preference set.
         #
-        #   @param branding [Knockapi::TenantSetParams::Settings::Branding] The branding for the tenant.
+        #   @param branding [Knockapi::Models::TenantSetParams::Settings::Branding] The branding for the tenant.
         #
-        #   @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
 
-        # @see Knockapi::TenantSetParams::Settings#branding
+        # @see Knockapi::Models::TenantSetParams::Settings#branding
         class Branding < Knockapi::Internal::Type::BaseModel
           # @!attribute icon_url
           #   The icon URL for the tenant. Must point to a valid image with an image MIME
@@ -90,7 +90,7 @@ module Knockapi
 
           # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
           #   Some parameter documentations has been truncated, see
-          #   {Knockapi::TenantSetParams::Settings::Branding} for more details.
+          #   {Knockapi::Models::TenantSetParams::Settings::Branding} for more details.
           #
           #   The branding for the tenant.
           #

data/lib/knockapi/models/tenants/bulk_set_params.rb

@@ -11,11 +11,11 @@ module Knockapi
         # @!attribute tenants
         #   The tenants to be upserted.
         #
-        #   @return [Array<String, Knockapi::TenantRequest>]
+        #   @return [Array<String, Knockapi::Models::TenantRequest>]
         required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::InlineTenantRequest] }
 
         # @!method initialize(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}]
       end

data/lib/knockapi/models/user.rb

@@ -63,8 +63,8 @@ module Knockapi
       optional :timezone, String, nil?: true
 
       # @!method initialize(id:, _typename:, updated_at:, avatar: nil, created_at: nil, email: nil, name: nil, phone_number: nil, timezone: nil)
-      #   Some parameter documentations has been truncated, see {Knockapi::User} for more
-      #   details.
+      #   Some parameter documentations has been truncated, see {Knockapi::Models::User}
+      #   for more details.
       #
       #   A [User](/concepts/users) represents an individual in your system who can
       #   receive notifications through Knock. Users are the most common recipients of

data/lib/knockapi/models/user_list_messages_params.rb

@@ -28,7 +28,7 @@ module Knockapi
       # @!attribute engagement_status
       #   Limits the results to messages with the given engagement status.
       #
-      #   @return [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>, nil]
+      #   @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>, nil]
       optional :engagement_status,
                -> {
                  Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::EngagementStatus]
@@ -36,7 +36,7 @@ module Knockapi
 
       # @!attribute inserted_at
       #
-      #   @return [Knockapi::UserListMessagesParams::InsertedAt, nil]
+      #   @return [Knockapi::Models::UserListMessagesParams::InsertedAt, nil]
       optional :inserted_at, -> { Knockapi::UserListMessagesParams::InsertedAt }
 
       # @!attribute message_ids
@@ -61,7 +61,7 @@ module Knockapi
       # @!attribute status
       #   Limits the results to messages with the given delivery status.
       #
-      #   @return [Array<Symbol, Knockapi::UserListMessagesParams::Status>, nil]
+      #   @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>, nil]
       optional :status,
                -> {
                  Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::Status]
@@ -110,9 +110,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
       #
@@ -120,7 +120,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.
       #
@@ -138,10 +138,13 @@ module Knockapi
         extend Knockapi::Internal::Type::Enum
 
         SEEN = :seen
+        UNSEEN = :unseen
         READ = :read
-        INTERACTED = :interacted
-        LINK_CLICKED = :link_clicked
+        UNREAD = :unread
         ARCHIVED = :archived
+        UNARCHIVED = :unarchived
+        LINK_CLICKED = :link_clicked
+        INTERACTED = :interacted
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/knockapi/models/user_list_params.rb

@@ -22,7 +22,7 @@ module Knockapi
       # @!attribute include
       #   Associated resources to include in the response.
       #
-      #   @return [Array<Symbol, Knockapi::UserListParams::Include>, nil]
+      #   @return [Array<Symbol, Knockapi::Models::UserListParams::Include>, nil]
       optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListParams::Include] }
 
       # @!attribute page_size
@@ -36,7 +36,7 @@ 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.
       #

data/lib/knockapi/models/user_list_subscriptions_params.rb

@@ -22,7 +22,7 @@ module Knockapi
       # @!attribute include
       #   Associated resources to include in the response.
       #
-      #   @return [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>, nil]
+      #   @return [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>, nil]
       optional :include,
                -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListSubscriptionsParams::Include] }
 
@@ -43,7 +43,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.
       #

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

@@ -11,11 +11,11 @@ module Knockapi
         # @!attribute users
         #   A list of users.
         #
-        #   @return [Array<Knockapi::InlineIdentifyUserRequest>]
+        #   @return [Array<Knockapi::Models::InlineIdentifyUserRequest>]
         required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineIdentifyUserRequest] }
 
         # @!method initialize(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}]
       end

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

@@ -11,7 +11,7 @@ module Knockapi
         # @!attribute preferences
         #   A request to set a preference set for a recipient.
         #
-        #   @return [Knockapi::Recipients::PreferenceSetRequest]
+        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest]
         required :preferences, -> { Knockapi::Recipients::PreferenceSetRequest }
 
         # @!attribute user_ids
@@ -21,7 +21,7 @@ module Knockapi
         required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
 
         # @!method initialize(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.
         #