knockapi 1.16.0 → 1.17.0

data/sig/knockapi/models/users/guide_get_channel_response.rbs

@@ -3,82 +3,345 @@ module Knockapi
     module Users
       type guide_get_channel_response =
         {
-          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
-          recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+          entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
+          guide_group_display_logs: ::Hash[Symbol, Time],
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
         }
 
       class GuideGetChannelResponse < Knockapi::Internal::Type::BaseModel
-        attr_accessor guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide]
+        attr_accessor entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry]
 
-        attr_accessor recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+        attr_accessor guide_group_display_logs: ::Hash[Symbol, Time]
+
+        attr_accessor guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
 
         def initialize: (
-          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
-          ?recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+          entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
+          guide_group_display_logs: ::Hash[Symbol, Time],
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
         ) -> void
 
         def to_hash: -> {
-          guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Guide],
-          recipient: Knockapi::Models::Users::GuideGetChannelResponse::Recipient?
+          entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
+          guide_group_display_logs: ::Hash[Symbol, Time],
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
         }
 
-        type guide =
+        type entry =
           {
             id: String,
+            _typename: String,
+            activation_url_patterns: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern],
+            activation_url_rules: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule],
             active: bool,
-            content: String,
-            metadata: ::Hash[Symbol, top],
-            title: String
+            bypass_global_group_limit: bool,
+            channel_id: String,
+            inserted_at: Time,
+            key: String,
+            semver: String,
+            steps: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step],
+            type: String,
+            updated_at: Time
           }
 
-        class Guide < Knockapi::Internal::Type::BaseModel
+        class Entry < Knockapi::Internal::Type::BaseModel
           attr_reader id: String?
 
           def id=: (String) -> String
 
+          attr_reader _typename: String?
+
+          def _typename=: (String) -> String
+
+          attr_reader activation_url_patterns: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern]?
+
+          def activation_url_patterns=: (
+            ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern]
+          ) -> ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern]
+
+          attr_reader activation_url_rules: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule]?
+
+          def activation_url_rules=: (
+            ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule]
+          ) -> ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule]
+
           attr_reader active: bool?
 
           def active=: (bool) -> bool
 
-          attr_reader content: String?
+          attr_reader bypass_global_group_limit: bool?
+
+          def bypass_global_group_limit=: (bool) -> bool
+
+          attr_reader channel_id: String?
+
+          def channel_id=: (String) -> String
 
-          def content=: (String) -> String
+          attr_reader inserted_at: Time?
 
-          attr_reader metadata: ::Hash[Symbol, top]?
+          def inserted_at=: (Time) -> Time
 
-          def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+          attr_reader key: String?
 
-          attr_reader title: String?
+          def key=: (String) -> String
 
-          def title=: (String) -> String
+          attr_reader semver: String?
+
+          def semver=: (String) -> String
+
+          attr_reader steps: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step]?
+
+          def steps=: (
+            ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step]
+          ) -> ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step]
+
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          attr_reader updated_at: Time?
+
+          def updated_at=: (Time) -> Time
 
           def initialize: (
             ?id: String,
+            ?_typename: String,
+            ?activation_url_patterns: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern],
+            ?activation_url_rules: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule],
             ?active: bool,
-            ?content: String,
-            ?metadata: ::Hash[Symbol, top],
-            ?title: String
+            ?bypass_global_group_limit: bool,
+            ?channel_id: String,
+            ?inserted_at: Time,
+            ?key: String,
+            ?semver: String,
+            ?steps: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step],
+            ?type: String,
+            ?updated_at: Time
           ) -> void
 
           def to_hash: -> {
             id: String,
+            _typename: String,
+            activation_url_patterns: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLPattern],
+            activation_url_rules: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::ActivationURLRule],
             active: bool,
-            content: String,
-            metadata: ::Hash[Symbol, top],
-            title: String
+            bypass_global_group_limit: bool,
+            channel_id: String,
+            inserted_at: Time,
+            key: String,
+            semver: String,
+            steps: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step],
+            type: String,
+            updated_at: Time
           }
+
+          type activation_url_pattern = { directive: String, pathname: String }
+
+          class ActivationURLPattern < Knockapi::Internal::Type::BaseModel
+            attr_reader directive: String?
+
+            def directive=: (String) -> String
+
+            attr_reader pathname: String?
+
+            def pathname=: (String) -> String
+
+            def initialize: (?directive: String, ?pathname: String) -> void
+
+            def to_hash: -> { directive: String, pathname: String }
+          end
+
+          type activation_url_rule =
+            {
+              argument: String,
+              directive: String,
+              operator: String,
+              variable: String
+            }
+
+          class ActivationURLRule < Knockapi::Internal::Type::BaseModel
+            attr_reader argument: String?
+
+            def argument=: (String) -> String
+
+            attr_reader directive: String?
+
+            def directive=: (String) -> String
+
+            attr_reader operator: String?
+
+            def operator=: (String) -> String
+
+            attr_reader variable: String?
+
+            def variable=: (String) -> String
+
+            def initialize: (
+              ?argument: String,
+              ?directive: String,
+              ?operator: String,
+              ?variable: String
+            ) -> void
+
+            def to_hash: -> {
+              argument: String,
+              directive: String,
+              operator: String,
+              variable: String
+            }
+          end
+
+          type step =
+            {
+              content: ::Hash[Symbol, top],
+              message: Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message,
+              ref: String,
+              schema_key: String,
+              schema_semver: String,
+              schema_variant_key: String
+            }
+
+          class Step < Knockapi::Internal::Type::BaseModel
+            attr_reader content: ::Hash[Symbol, top]?
+
+            def content=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+            attr_reader message: Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message?
+
+            def message=: (
+              Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message
+            ) -> Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message
+
+            attr_reader ref: String?
+
+            def ref=: (String) -> String
+
+            attr_reader schema_key: String?
+
+            def schema_key=: (String) -> String
+
+            attr_reader schema_semver: String?
+
+            def schema_semver=: (String) -> String
+
+            attr_reader schema_variant_key: String?
+
+            def schema_variant_key=: (String) -> String
+
+            def initialize: (
+              ?content: ::Hash[Symbol, top],
+              ?message: Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message,
+              ?ref: String,
+              ?schema_key: String,
+              ?schema_semver: String,
+              ?schema_variant_key: String
+            ) -> void
+
+            def to_hash: -> {
+              content: ::Hash[Symbol, top],
+              message: Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step::Message,
+              ref: String,
+              schema_key: String,
+              schema_semver: String,
+              schema_variant_key: String
+            }
+
+            type message =
+              {
+                id: String?,
+                archived_at: Time?,
+                interacted_at: Time?,
+                link_clicked_at: Time?,
+                read_at: Time?,
+                seen_at: Time?
+              }
+
+            class Message < Knockapi::Internal::Type::BaseModel
+              attr_accessor id: String?
+
+              attr_accessor archived_at: Time?
+
+              attr_accessor interacted_at: Time?
+
+              attr_accessor link_clicked_at: Time?
+
+              attr_accessor read_at: Time?
+
+              attr_accessor seen_at: Time?
+
+              def initialize: (
+                ?id: String?,
+                ?archived_at: Time?,
+                ?interacted_at: Time?,
+                ?link_clicked_at: Time?,
+                ?read_at: Time?,
+                ?seen_at: Time?
+              ) -> void
+
+              def to_hash: -> {
+                id: String?,
+                archived_at: Time?,
+                interacted_at: Time?,
+                link_clicked_at: Time?,
+                read_at: Time?,
+                seen_at: Time?
+              }
+            end
+          end
         end
 
-        type recipient = { id: String }
+        type guide_group =
+          {
+            _typename: String,
+            display_interval: Integer,
+            display_sequence: ::Array[String],
+            inserted_at: Time,
+            key: String,
+            updated_at: Time
+          }
 
-        class Recipient < Knockapi::Internal::Type::BaseModel
-          attr_reader id: String?
+        class GuideGroup < Knockapi::Internal::Type::BaseModel
+          attr_reader _typename: String?
 
-          def id=: (String) -> String
+          def _typename=: (String) -> String
+
+          attr_reader display_interval: Integer?
+
+          def display_interval=: (Integer) -> Integer
+
+          attr_reader display_sequence: ::Array[String]?
+
+          def display_sequence=: (::Array[String]) -> ::Array[String]
+
+          attr_reader inserted_at: Time?
 
-          def initialize: (?id: String) -> void
+          def inserted_at=: (Time) -> Time
 
-          def to_hash: -> { id: String }
+          attr_reader key: String?
+
+          def key=: (String) -> String
+
+          attr_reader updated_at: Time?
+
+          def updated_at=: (Time) -> Time
+
+          def initialize: (
+            ?_typename: String,
+            ?display_interval: Integer,
+            ?display_sequence: ::Array[String],
+            ?inserted_at: Time,
+            ?key: String,
+            ?updated_at: Time
+          ) -> void
+
+          def to_hash: -> {
+            _typename: String,
+            display_interval: Integer,
+            display_sequence: ::Array[String],
+            inserted_at: Time,
+            key: String,
+            updated_at: Time
+          }
         end
       end
     end

data/sig/knockapi/resources/objects.rbs

@@ -128,6 +128,8 @@ module Knockapi
         ?_persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
+        ?channels: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::channel]?,
+        ?commercial_subscribed: bool?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet

data/sig/knockapi/resources/users.rbs

@@ -115,6 +115,8 @@ module Knockapi
         ?_persistence_strategy: Knockapi::Models::Recipients::PreferenceSetRequest::persistence_strategy,
         ?categories: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::category]?,
         ?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
+        ?channels: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::channel]?,
+        ?commercial_subscribed: bool?,
         ?workflows: ::Hash[Symbol, Knockapi::Models::Recipients::PreferenceSetRequest::workflow]?,
         ?request_options: Knockapi::request_opts
       ) -> Knockapi::Recipients::PreferenceSet

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-07 00:00:00.000000000 Z
+date: 2025-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -156,12 +156,10 @@ files:
 - lib/knockapi/models/recipients/inline_channel_data_request.rb
 - lib/knockapi/models/recipients/inline_preference_set_request.rb
 - lib/knockapi/models/recipients/ms_teams_channel_data.rb
-- lib/knockapi/models/recipients/one_signal_channel_data.rb
 - lib/knockapi/models/recipients/preference_set.rb
 - lib/knockapi/models/recipients/preference_set_channel_type_setting.rb
 - lib/knockapi/models/recipients/preference_set_channel_types.rb
 - lib/knockapi/models/recipients/preference_set_request.rb
-- lib/knockapi/models/recipients/push_channel_data.rb
 - lib/knockapi/models/recipients/slack_channel_data.rb
 - lib/knockapi/models/recipients/subscription.rb
 - lib/knockapi/models/schedule.rb
@@ -366,12 +364,10 @@ files:
 - rbi/knockapi/models/recipients/inline_channel_data_request.rbi
 - rbi/knockapi/models/recipients/inline_preference_set_request.rbi
 - rbi/knockapi/models/recipients/ms_teams_channel_data.rbi
-- rbi/knockapi/models/recipients/one_signal_channel_data.rbi
 - rbi/knockapi/models/recipients/preference_set.rbi
 - rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi
 - rbi/knockapi/models/recipients/preference_set_channel_types.rbi
 - rbi/knockapi/models/recipients/preference_set_request.rbi
-- rbi/knockapi/models/recipients/push_channel_data.rbi
 - rbi/knockapi/models/recipients/slack_channel_data.rbi
 - rbi/knockapi/models/recipients/subscription.rbi
 - rbi/knockapi/models/schedule.rbi
@@ -575,12 +571,10 @@ files:
 - sig/knockapi/models/recipients/inline_channel_data_request.rbs
 - sig/knockapi/models/recipients/inline_preference_set_request.rbs
 - sig/knockapi/models/recipients/ms_teams_channel_data.rbs
-- sig/knockapi/models/recipients/one_signal_channel_data.rbs
 - sig/knockapi/models/recipients/preference_set.rbs
 - sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs
 - sig/knockapi/models/recipients/preference_set_channel_types.rbs
 - sig/knockapi/models/recipients/preference_set_request.rbs
-- sig/knockapi/models/recipients/push_channel_data.rbs
 - sig/knockapi/models/recipients/slack_channel_data.rbs
 - sig/knockapi/models/recipients/subscription.rbs
 - sig/knockapi/models/schedule.rbs

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Knockapi
-  module Models
-    module Recipients
-      class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
-        # @!attribute player_ids
-        #   A list of OneSignal player IDs.
-        #
-        #   @return [Array<String>]
-        required :player_ids, Knockapi::Internal::Type::ArrayOf[String]
-
-        # @!method initialize(player_ids:)
-        #   OneSignal channel data.
-        #
-        #   @param player_ids [Array<String>] A list of OneSignal player IDs.
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Knockapi
-  module Models
-    module Recipients
-      class PushChannelData < Knockapi::Internal::Type::BaseModel
-        # @!attribute tokens
-        #   A list of push channel tokens.
-        #
-        #   @return [Array<String>]
-        required :tokens, Knockapi::Internal::Type::ArrayOf[String]
-
-        # @!method initialize(tokens:)
-        #   Push channel data.
-        #
-        #   @param tokens [Array<String>] A list of push channel tokens.
-      end
-    end
-  end
-end

data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi

@@ -1,33 +0,0 @@
-# typed: strong
-
-module Knockapi
-  module Models
-    module Recipients
-      class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Knockapi::Recipients::OneSignalChannelData,
-              Knockapi::Internal::AnyHash
-            )
-          end
-
-        # A list of OneSignal player IDs.
-        sig { returns(T::Array[String]) }
-        attr_accessor :player_ids
-
-        # OneSignal channel data.
-        sig { params(player_ids: T::Array[String]).returns(T.attached_class) }
-        def self.new(
-          # A list of OneSignal player IDs.
-          player_ids:
-        )
-        end
-
-        sig { override.returns({ player_ids: T::Array[String] }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/knockapi/models/recipients/push_channel_data.rbi

@@ -1,33 +0,0 @@
-# typed: strong
-
-module Knockapi
-  module Models
-    module Recipients
-      class PushChannelData < Knockapi::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Knockapi::Recipients::PushChannelData,
-              Knockapi::Internal::AnyHash
-            )
-          end
-
-        # A list of push channel tokens.
-        sig { returns(T::Array[String]) }
-        attr_accessor :tokens
-
-        # Push channel data.
-        sig { params(tokens: T::Array[String]).returns(T.attached_class) }
-        def self.new(
-          # A list of push channel tokens.
-          tokens:
-        )
-        end
-
-        sig { override.returns({ tokens: T::Array[String] }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/sig/knockapi/models/recipients/one_signal_channel_data.rbs

@@ -1,15 +0,0 @@
-module Knockapi
-  module Models
-    module Recipients
-      type one_signal_channel_data = { player_ids: ::Array[String] }
-
-      class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
-        attr_accessor player_ids: ::Array[String]
-
-        def initialize: (player_ids: ::Array[String]) -> void
-
-        def to_hash: -> { player_ids: ::Array[String] }
-      end
-    end
-  end
-end

data/sig/knockapi/models/recipients/push_channel_data.rbs

@@ -1,15 +0,0 @@
-module Knockapi
-  module Models
-    module Recipients
-      type push_channel_data = { tokens: ::Array[String] }
-
-      class PushChannelData < Knockapi::Internal::Type::BaseModel
-        attr_accessor tokens: ::Array[String]
-
-        def initialize: (tokens: ::Array[String]) -> void
-
-        def to_hash: -> { tokens: ::Array[String] }
-      end
-    end
-  end
-end