knockapi 1.16.0 → 1.17.0

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

@@ -30,6 +30,23 @@ module Knockapi
         #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
         optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
 
+        # @!attribute channels
+        #   Channel preferences.
+        #
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil]
+        optional :channels,
+                 -> {
+                   Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Channel]
+                 },
+                 nil?: true
+
+        # @!attribute commercial_subscribed
+        #   Whether the recipient is subscribed to commercial communications. When false,
+        #   the recipient will not receive commercial workflow notifications.
+        #
+        #   @return [Boolean, nil]
+        optional :commercial_subscribed, Knockapi::Internal::Type::Boolean, nil?: true
+
         # @!attribute workflows
         #   An object where the key is the workflow key and the values are the preference
         #   settings for that workflow.
@@ -41,7 +58,7 @@ module Knockapi
                  },
                  nil?: true
 
-        # @!method initialize(_persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil)
+        # @!method initialize(_persistence_strategy: nil, categories: nil, channel_types: nil, channels: nil, commercial_subscribed: nil, workflows: nil)
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Recipients::PreferenceSetRequest} for more details.
         #
@@ -53,6 +70,10 @@ module Knockapi
         #
         #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
         #
+        #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+        #
+        #   @param commercial_subscribed [Boolean, nil] Whether the recipient is subscribed to commercial communications. When false, th
+        #
         #   @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
 
         # Controls how the preference set is persisted. 'replace' will completely replace
@@ -85,25 +106,95 @@ module Knockapi
             #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
             optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
 
+            # @!attribute channels
+            #   Channel preferences.
+            #
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            optional :channels,
+                     -> do
+                       Knockapi::Internal::Type::HashOf[
+                         union: Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel
+                       ]
+                     end,
+                     nil?: true
+
             # @!attribute conditions
             #   A list of conditions to apply to a channel type.
             #
             #   @return [Array<Knockapi::Models::Condition>, nil]
             optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
 
-            # @!method initialize(channel_types: nil, conditions: nil)
+            # @!method initialize(channel_types: nil, channels: nil, conditions: nil)
             #   The settings object for a workflow or category, where you can specify channel
             #   types or conditions.
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
+            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+            #
             #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
+
+            # Whether the specific channel (by channel_id) is enabled for the preference set,
+            # or a settings object with conditions.
+            module Channel
+              extend Knockapi::Internal::Type::Union
+
+              variant Knockapi::Internal::Type::Boolean
+
+              # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+              variant -> { Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting }
+
+              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+                # @!attribute conditions
+                #   A list of conditions to apply to a specific channel.
+                #
+                #   @return [Array<Knockapi::Models::Condition>]
+                required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
+
+                # @!method initialize(conditions:)
+                #   A set of settings for a specific channel. Currently, this can only be a list of
+                #   conditions to apply.
+                #
+                #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
+              end
+
+              # @!method self.variants
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+            end
           end
 
           # @!method self.variants
           #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
         end
 
+        # Whether the specific channel (by channel_id) is enabled for the preference set,
+        # or a settings object with conditions.
+        module Channel
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+          variant -> { Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting }
+
+          class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+            # @!attribute conditions
+            #   A list of conditions to apply to a specific channel.
+            #
+            #   @return [Array<Knockapi::Models::Condition>]
+            required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
+
+            # @!method initialize(conditions:)
+            #   A set of settings for a specific channel. Currently, this can only be a list of
+            #   conditions to apply.
+            #
+            #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting)]
+        end
+
         # Workflow or category preferences within a preference set
         module Workflow
           extend Knockapi::Internal::Type::Union
@@ -120,19 +211,61 @@ module Knockapi
             #   @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
             optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
 
+            # @!attribute channels
+            #   Channel preferences.
+            #
+            #   @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil]
+            optional :channels,
+                     -> do
+                       Knockapi::Internal::Type::HashOf[
+                         union: Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel
+                       ]
+                     end,
+                     nil?: true
+
             # @!attribute conditions
             #   A list of conditions to apply to a channel type.
             #
             #   @return [Array<Knockapi::Models::Condition>, nil]
             optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
 
-            # @!method initialize(channel_types: nil, conditions: nil)
+            # @!method initialize(channel_types: nil, channels: nil, conditions: nil)
             #   The settings object for a workflow or category, where you can specify channel
             #   types or conditions.
             #
             #   @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
             #
+            #   @param channels [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting}, nil] Channel preferences.
+            #
             #   @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
+
+            # Whether the specific channel (by channel_id) is enabled for the preference set,
+            # or a settings object with conditions.
+            module Channel
+              extend Knockapi::Internal::Type::Union
+
+              variant Knockapi::Internal::Type::Boolean
+
+              # A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
+              variant -> { Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting }
+
+              class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
+                # @!attribute conditions
+                #   A list of conditions to apply to a specific channel.
+                #
+                #   @return [Array<Knockapi::Models::Condition>]
+                required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
+
+                # @!method initialize(conditions:)
+                #   A set of settings for a specific channel. Currently, this can only be a list of
+                #   conditions to apply.
+                #
+                #   @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a specific channel.
+              end
+
+              # @!method self.variants
+              #   @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting)]
+            end
           end
 
           # @!method self.variants

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::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -44,7 +44,7 @@ module Knockapi
       #
       #   @param id [String] The unique identifier for the tenant.
       #
-      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, 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 channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
       #

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::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
       optional :channel_data,
                -> {
                  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -24,7 +24,7 @@ module Knockapi
       optional :settings, -> { Knockapi::TenantSetParams::Settings }
 
       # @!method initialize(channel_data: nil, settings: nil, request_options: {})
-      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, 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 channel_data [Hash{Symbol=>Knockapi::Models::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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 settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
       #

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

@@ -5,81 +5,317 @@ module Knockapi
     module Users
       # @see Knockapi::Resources::Users::Guides#get_channel
       class GuideGetChannelResponse < Knockapi::Internal::Type::BaseModel
-        # @!attribute guides
+        # @!attribute entries
         #   A list of guides.
         #
-        #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Guide>]
-        required :guides,
-                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Guide] }
+        #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry>]
+        required :entries,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry] }
 
-        # @!attribute recipient
-        #   The recipient of the guide.
+        # @!attribute guide_group_display_logs
+        #   A map of guide group keys to their last display timestamps.
         #
-        #   @return [Knockapi::Models::Users::GuideGetChannelResponse::Recipient, nil]
-        optional :recipient, -> { Knockapi::Models::Users::GuideGetChannelResponse::Recipient }, nil?: true
+        #   @return [Hash{Symbol=>Time}]
+        required :guide_group_display_logs, Knockapi::Internal::Type::HashOf[Time]
 
-        # @!method initialize(guides:, recipient: nil)
+        # @!attribute guide_groups
+        #   A list of guide groups with their display sequences and intervals.
+        #
+        #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup>]
+        required :guide_groups,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup] }
+
+        # @!method initialize(entries:, guide_group_display_logs:, guide_groups:)
         #   A response for a list of guides.
         #
-        #   @param guides [Array<Knockapi::Models::Users::GuideGetChannelResponse::Guide>] A list of guides.
+        #   @param entries [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry>] A list of guides.
+        #
+        #   @param guide_group_display_logs [Hash{Symbol=>Time}] A map of guide group keys to their last display timestamps.
         #
-        #   @param recipient [Knockapi::Models::Users::GuideGetChannelResponse::Recipient, nil] The recipient of the guide.
+        #   @param guide_groups [Array<Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup>] A list of guide groups with their display sequences and intervals.
 
-        class Guide < Knockapi::Internal::Type::BaseModel
+        class Entry < Knockapi::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the guide.
           #
           #   @return [String, nil]
           optional :id, String
 
+          # @!attribute _typename
+          #   The typename of the schema.
+          #
+          #   @return [String, nil]
+          optional :_typename, String, api_name: :__typename
+
+          # @!attribute activation_url_patterns
+          #   A list of URL Patterns to evaluate user's current location to activate the
+          #   guide, if matched
+          #
+          #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>, nil]
+          optional :activation_url_patterns,
+                   -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern] }
+
+          # @!attribute activation_url_rules
+          #   A list of URL rules to evaluate user's current location to activate the guide,
+          #   if matched
+          #
+          #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>, nil]
+          optional :activation_url_rules,
+                   -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule] }
+
           # @!attribute active
           #   Whether the guide is active.
           #
           #   @return [Boolean, nil]
           optional :active, Knockapi::Internal::Type::Boolean
 
-          # @!attribute content
-          #   The content of the guide.
+          # @!attribute bypass_global_group_limit
+          #
+          #   @return [Boolean, nil]
+          optional :bypass_global_group_limit, Knockapi::Internal::Type::Boolean
+
+          # @!attribute channel_id
           #
           #   @return [String, nil]
-          optional :content, String
+          optional :channel_id, String
 
-          # @!attribute metadata
-          #   The metadata of the guide.
+          # @!attribute inserted_at
           #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+          #   @return [Time, nil]
+          optional :inserted_at, Time
 
-          # @!attribute title
-          #   The title of the guide.
+          # @!attribute key
+          #   The key of the guide.
           #
           #   @return [String, nil]
-          optional :title, String
+          optional :key, String
 
-          # @!method initialize(id: nil, active: nil, content: nil, metadata: nil, title: nil)
+          # @!attribute semver
+          #
+          #   @return [String, nil]
+          optional :semver, String
+
+          # @!attribute steps
+          #
+          #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>, nil]
+          optional :steps,
+                   -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step] }
+
+          # @!attribute type
+          #   The type of the guide.
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, _typename: nil, activation_url_patterns: nil, activation_url_rules: nil, active: nil, bypass_global_group_limit: nil, channel_id: nil, inserted_at: nil, key: nil, semver: nil, steps: nil, type: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Users::GuideGetChannelResponse::Entry} for more details.
+          #
           #   @param id [String] The unique identifier for the guide.
           #
+          #   @param _typename [String] The typename of the schema.
+          #
+          #   @param activation_url_patterns [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern>] A list of URL Patterns to evaluate user's current location to activate the guide
+          #
+          #   @param activation_url_rules [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule>] A list of URL rules to evaluate user's current location to activate the guide, i
+          #
           #   @param active [Boolean] Whether the guide is active.
           #
-          #   @param content [String] The content of the guide.
+          #   @param bypass_global_group_limit [Boolean]
+          #
+          #   @param channel_id [String]
+          #
+          #   @param inserted_at [Time]
           #
-          #   @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+          #   @param key [String] The key of the guide.
           #
-          #   @param title [String] The title of the guide.
+          #   @param semver [String]
+          #
+          #   @param steps [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step>]
+          #
+          #   @param type [String] The type of the guide.
+          #
+          #   @param updated_at [Time]
+
+          class ActivationURLPattern < Knockapi::Internal::Type::BaseModel
+            # @!attribute directive
+            #   The directive for the URL pattern ('allow' or 'block')
+            #
+            #   @return [String, nil]
+            optional :directive, String
+
+            # @!attribute pathname
+            #   The pathname pattern to match (supports wildcards like /\*)
+            #
+            #   @return [String, nil]
+            optional :pathname, String
+
+            # @!method initialize(directive: nil, pathname: nil)
+            #   @param directive [String] The directive for the URL pattern ('allow' or 'block')
+            #
+            #   @param pathname [String] The pathname pattern to match (supports wildcards like /\*)
+          end
+
+          class ActivationURLRule < Knockapi::Internal::Type::BaseModel
+            # @!attribute argument
+            #   The value to compare against
+            #
+            #   @return [String, nil]
+            optional :argument, String
+
+            # @!attribute directive
+            #   The directive for the URL pattern ('allow' or 'block')
+            #
+            #   @return [String, nil]
+            optional :directive, String
+
+            # @!attribute operator
+            #   The comparison operator ('contains' or 'equal_to')
+            #
+            #   @return [String, nil]
+            optional :operator, String
+
+            # @!attribute variable
+            #   The variable to evaluate ('pathname')
+            #
+            #   @return [String, nil]
+            optional :variable, String
+
+            # @!method initialize(argument: nil, directive: nil, operator: nil, variable: nil)
+            #   @param argument [String] The value to compare against
+            #
+            #   @param directive [String] The directive for the URL pattern ('allow' or 'block')
+            #
+            #   @param operator [String] The comparison operator ('contains' or 'equal_to')
+            #
+            #   @param variable [String] The variable to evaluate ('pathname')
+          end
+
+          class Step < Knockapi::Internal::Type::BaseModel
+            # @!attribute content
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+            # @!attribute message
+            #
+            #   @return [Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message, nil]
+            optional :message, -> { Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message }
+
+            # @!attribute ref
+            #
+            #   @return [String, nil]
+            optional :ref, String
+
+            # @!attribute schema_key
+            #
+            #   @return [String, nil]
+            optional :schema_key, String
+
+            # @!attribute schema_semver
+            #
+            #   @return [String, nil]
+            optional :schema_semver, String
+
+            # @!attribute schema_variant_key
+            #
+            #   @return [String, nil]
+            optional :schema_variant_key, String
+
+            # @!method initialize(content: nil, message: nil, ref: nil, schema_key: nil, schema_semver: nil, schema_variant_key: nil)
+            #   @param content [Hash{Symbol=>Object}]
+            #   @param message [Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message]
+            #   @param ref [String]
+            #   @param schema_key [String]
+            #   @param schema_semver [String]
+            #   @param schema_variant_key [String]
+
+            # @see Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step#message
+            class Message < Knockapi::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String, nil]
+              optional :id, String, nil?: true
+
+              # @!attribute archived_at
+              #
+              #   @return [Time, nil]
+              optional :archived_at, Time, nil?: true
+
+              # @!attribute interacted_at
+              #
+              #   @return [Time, nil]
+              optional :interacted_at, Time, nil?: true
+
+              # @!attribute link_clicked_at
+              #
+              #   @return [Time, nil]
+              optional :link_clicked_at, Time, nil?: true
+
+              # @!attribute read_at
+              #
+              #   @return [Time, nil]
+              optional :read_at, Time, nil?: true
+
+              # @!attribute seen_at
+              #
+              #   @return [Time, nil]
+              optional :seen_at, Time, nil?: true
+
+              # @!method initialize(id: nil, archived_at: nil, interacted_at: nil, link_clicked_at: nil, read_at: nil, seen_at: nil)
+              #   @param id [String, nil]
+              #   @param archived_at [Time, nil]
+              #   @param interacted_at [Time, nil]
+              #   @param link_clicked_at [Time, nil]
+              #   @param read_at [Time, nil]
+              #   @param seen_at [Time, nil]
+            end
+          end
         end
 
-        # @see Knockapi::Models::Users::GuideGetChannelResponse#recipient
-        class Recipient < Knockapi::Internal::Type::BaseModel
-          # @!attribute id
-          #   Unique identifier for the recipient.
+        class GuideGroup < Knockapi::Internal::Type::BaseModel
+          # @!attribute _typename
           #
           #   @return [String, nil]
-          optional :id, String
+          optional :_typename, String, api_name: :__typename
+
+          # @!attribute display_interval
+          #
+          #   @return [Integer, nil]
+          optional :display_interval, Integer
 
-          # @!method initialize(id: nil)
-          #   The recipient of the guide.
+          # @!attribute display_sequence
           #
-          #   @param id [String] Unique identifier for the recipient.
+          #   @return [Array<String>, nil]
+          optional :display_sequence, Knockapi::Internal::Type::ArrayOf[String]
+
+          # @!attribute inserted_at
+          #
+          #   @return [Time, nil]
+          optional :inserted_at, Time
+
+          # @!attribute key
+          #
+          #   @return [String, nil]
+          optional :key, String
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(_typename: nil, display_interval: nil, display_sequence: nil, inserted_at: nil, key: nil, updated_at: nil)
+          #   @param _typename [String]
+          #   @param display_interval [Integer]
+          #   @param display_sequence [Array<String>]
+          #   @param inserted_at [Time]
+          #   @param key [String]
+          #   @param updated_at [Time]
         end
       end
     end

data/lib/knockapi/resources/messages/batch.rb

@@ -22,7 +22,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/archived",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -72,7 +72,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/interacted",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -95,7 +95,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/read",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -119,7 +119,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/seen",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -143,7 +143,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/unread",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -167,7 +167,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/unseen",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -191,7 +191,7 @@ module Knockapi
             method: :post,
             path: "v1/messages/batch/unarchived",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end