knockapi 1.16.0 → 1.18.0

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

data/lib/knockapi/resources/objects.rb

@@ -368,7 +368,7 @@ module Knockapi
       #
       # @param id [String] Unique identifier for the object.
       #
-      # @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}] 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::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly, 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
       #
@@ -404,7 +404,7 @@ module Knockapi
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
-      # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
+      # @param data [Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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]
       #
@@ -434,7 +434,7 @@ module Knockapi
       # `tenant.id`. Learn more about
       # [per-tenant preferences](/preferences/tenant-preferences).
       #
-      # @overload set_preferences(collection, object_id_, id, _persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil, request_options: {})
+      # @overload set_preferences(collection, object_id_, id, _persistence_strategy: nil, categories: nil, channel_types: nil, channels: nil, commercial_subscribed: nil, workflows: nil, request_options: {})
       #
       # @param collection [String] The collection this object belongs to.
       #
@@ -448,6 +448,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
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/knockapi/resources/tenants.rb

@@ -84,7 +84,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::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, 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/resources/users.rb

@@ -25,7 +25,7 @@ module Knockapi
       #
       # @param avatar [String, nil] A URL for the avatar of the user.
       #
-      # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::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::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly, 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 created_at [Time, nil] The creation date of the user from your system.
       #
@@ -354,7 +354,7 @@ module Knockapi
       #
       # @param channel_id [String] The unique identifier for the channel.
       #
-      # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
+      # @param data [Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataTokensOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataTargetArNsOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwssnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::ChannelDataRequest::Data::OneSignalChannelDataPlayerIDsOnly, 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]
       #
@@ -380,7 +380,7 @@ module Knockapi
       # Use '**persistence_strategy**': 'merge' to merge with existing preferences
       # instead.
       #
-      # @overload set_preferences(user_id, id, _persistence_strategy: nil, categories: nil, channel_types: nil, workflows: nil, request_options: {})
+      # @overload set_preferences(user_id, id, _persistence_strategy: nil, categories: nil, channel_types: nil, channels: nil, commercial_subscribed: nil, workflows: nil, request_options: {})
       #
       # @param user_id [String] The unique identifier of the user.
       #
@@ -392,6 +392,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
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.16.0"
+  VERSION = "1.18.0"
 end

data/lib/knockapi.rb

@@ -151,11 +151,9 @@ require_relative "knockapi/models/recipients/discord_channel_data"
 require_relative "knockapi/models/recipients/inline_channel_data_request"
 require_relative "knockapi/models/recipients/inline_preference_set_request"
 require_relative "knockapi/models/recipients/ms_teams_channel_data"
-require_relative "knockapi/models/recipients/one_signal_channel_data"
 require_relative "knockapi/models/recipients/preference_set"
 require_relative "knockapi/models/recipients/preference_set_channel_types"
 require_relative "knockapi/models/recipients/preference_set_channel_type_setting"
-require_relative "knockapi/models/recipients/push_channel_data"
 require_relative "knockapi/models/recipients/channel_data"
 require_relative "knockapi/models/recipients/slack_channel_data"
 require_relative "knockapi/models/recipients/subscription"

data/rbi/knockapi/models/identify_user_request.rbi

@@ -19,9 +19,11 @@ module Knockapi
             T::Hash[
               Symbol,
               T.any(
-                Knockapi::Recipients::PushChannelData,
-                Knockapi::Recipients::OneSignalChannelData,
-                Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
                 Knockapi::Recipients::SlackChannelData,
                 Knockapi::Recipients::MsTeamsChannelData,
                 Knockapi::Recipients::DiscordChannelData
@@ -81,9 +83,11 @@ module Knockapi
               T::Hash[
                 Symbol,
                 T.any(
-                  Knockapi::Recipients::PushChannelData::OrHash,
-                  Knockapi::Recipients::OneSignalChannelData::OrHash,
-                  Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
                   Knockapi::Recipients::SlackChannelData::OrHash,
                   Knockapi::Recipients::MsTeamsChannelData::OrHash,
                   Knockapi::Recipients::DiscordChannelData::OrHash
@@ -142,9 +146,11 @@ module Knockapi
                 T::Hash[
                   Symbol,
                   T.any(
-                    Knockapi::Recipients::PushChannelData,
-                    Knockapi::Recipients::OneSignalChannelData,
-                    Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
                     Knockapi::Recipients::SlackChannelData,
                     Knockapi::Recipients::MsTeamsChannelData,
                     Knockapi::Recipients::DiscordChannelData

data/rbi/knockapi/models/inline_identify_user_request.rbi

@@ -26,9 +26,11 @@ module Knockapi
             T::Hash[
               Symbol,
               T.any(
-                Knockapi::Recipients::PushChannelData,
-                Knockapi::Recipients::OneSignalChannelData,
-                Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+                Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
                 Knockapi::Recipients::SlackChannelData,
                 Knockapi::Recipients::MsTeamsChannelData,
                 Knockapi::Recipients::DiscordChannelData
@@ -90,9 +92,11 @@ module Knockapi
               T::Hash[
                 Symbol,
                 T.any(
-                  Knockapi::Recipients::PushChannelData::OrHash,
-                  Knockapi::Recipients::OneSignalChannelData::OrHash,
-                  Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly::OrHash,
+                  Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly::OrHash,
                   Knockapi::Recipients::SlackChannelData::OrHash,
                   Knockapi::Recipients::MsTeamsChannelData::OrHash,
                   Knockapi::Recipients::DiscordChannelData::OrHash
@@ -154,9 +158,11 @@ module Knockapi
                 T::Hash[
                   Symbol,
                   T.any(
-                    Knockapi::Recipients::PushChannelData,
-                    Knockapi::Recipients::OneSignalChannelData,
-                    Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataTokensOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::PushChannelDataDevicesOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataTargetArNsOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::AwssnsPushChannelDataDevicesOnly,
+                    Knockapi::Recipients::InlineChannelDataRequestItem::OneSignalChannelDataPlayerIDsOnly,
                     Knockapi::Recipients::SlackChannelData,
                     Knockapi::Recipients::MsTeamsChannelData,
                     Knockapi::Recipients::DiscordChannelData