knockapi 1.25.1 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95dc137b6092011539e7c489a17decbd00009f5be384d2577032c45dc61206ba
-  data.tar.gz: 9763c56b2a6c1a0eda462a7b513deced67343e1d02b1d184250bd22f98c57287
+  metadata.gz: 42cb0fe9e17a3aa6604e9b5059e49852d7289815cc62c96ea60dfcc95a9f3d83
+  data.tar.gz: dc86f87556acc0929eb541f2102b12f397363cf8e2498329e2969202038313da
 SHA512:
-  metadata.gz: b77d86b976ae7194bee86cf80584d7dba83bdf46cacf79a874bd5349023e23d32fb01c0ddc164ceea9fdb5b3b6e56a1af8b3173304f23c8905215906413e4129
-  data.tar.gz: b12fa4303ad159a34b6941febfd6fa16827dd44270b67a858bbb3a7f5c67b6d5d2b67aa1ecf0763fa4f4f1fda3e9855fc1003f6e9ed438fe2e4d9112191d46f2
+  metadata.gz: 804874b733eb20bacb0b382660825015558e582a7f450538d9226b4f9be6fc58f2175c9740d36a79cc4363e2b214ec3361c399e6a9832878364485e9e0164f06
+  data.tar.gz: 9d1bc8e9d15cc4b0113e8df8351f7d3309199132d8adcf24475d0fcfa1d1e48cb695a596725c3d93caf65fa9a7144f581c0606e99f6d7ee0fe2c67faab3dbf97

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.26.0 (2026-01-16)
+
+Full Changelog: [v1.25.1...v1.26.0](https://github.com/knocklabs/knock-ruby/compare/v1.25.1...v1.26.0)
+
+### Features
+
+* **api:** api update ([04d2e5a](https://github.com/knocklabs/knock-ruby/commit/04d2e5a33c984fc502525a4994cd3e15023b028a))
+* **api:** api update ([0e52398](https://github.com/knocklabs/knock-ruby/commit/0e52398502d88f25790725df54813f5cece44a69))
+
+
+### Chores
+
+* **internal:** update `actions/checkout` version ([aa18733](https://github.com/knocklabs/knock-ruby/commit/aa187339691334c36410d2eb2d35eeb62addc122))
+* move `cgi` into dependencies for ruby 4 ([e06fcea](https://github.com/knocklabs/knock-ruby/commit/e06fcea3affc4265c987a44731bd7c6c83ef291d))
+
 ## 1.25.1 (2026-01-05)
 
 Full Changelog: [v1.25.0...v1.25.1](https://github.com/knocklabs/knock-ruby/compare/v1.25.0...v1.25.1)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "knockapi", "~> 1.25.1"
+gem "knockapi", "~> 1.26.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/models/condition.rb

@@ -49,7 +49,7 @@ module Knockapi
         CONTAINS_ALL = :contains_all
         IS_TIMESTAMP = :is_timestamp
         IS_NOT_TIMESTAMP = :is_not_timestamp
-        IS_TIMESTAMP_AFTER = :is_timestamp_after
+        IS_TIMESTAMP_ON_OR_AFTER = :is_timestamp_on_or_after
         IS_TIMESTAMP_BEFORE = :is_timestamp_before
         IS_TIMESTAMP_BETWEEN = :is_timestamp_between
         IS_AUDIENCE_MEMBER = :is_audience_member

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

@@ -25,7 +25,14 @@ module Knockapi
         required :guide_groups,
                  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup] }
 
-        # @!method initialize(entries:, guide_group_display_logs:, guide_groups:)
+        # @!attribute ineligible_guides
+        #   Markers for guides the user is not eligible to see.
+        #
+        #   @return [Array<Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide>]
+        required :ineligible_guides,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide] }
+
+        # @!method initialize(entries:, guide_group_display_logs:, guide_groups:, ineligible_guides:)
         #   A response for a list of guides.
         #
         #   @param entries [Array<Knockapi::Models::Users::GuideGetChannelResponse::Entry>] A list of guides.
@@ -33,6 +40,8 @@ module Knockapi
         #   @param guide_group_display_logs [Hash{Symbol=>Time}] A map of guide group keys to their last display timestamps.
         #
         #   @param guide_groups [Array<Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup>] A list of guide groups with their display sequences and intervals.
+        #
+        #   @param ineligible_guides [Array<Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide>] Markers for guides the user is not eligible to see.
 
         class Entry < Knockapi::Internal::Type::BaseModel
           # @!attribute id
@@ -317,6 +326,48 @@ module Knockapi
           #   @param key [String]
           #   @param updated_at [Time]
         end
+
+        class IneligibleGuide < Knockapi::Internal::Type::BaseModel
+          # @!attribute key
+          #   The guide's key identifier
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute message
+          #   Human-readable explanation of ineligibility
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute reason
+          #   Reason code for ineligibility
+          #
+          #   @return [Symbol, Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason]
+          required :reason, enum: -> { Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason }
+
+          # @!method initialize(key:, message:, reason:)
+          #   @param key [String] The guide's key identifier
+          #
+          #   @param message [String] Human-readable explanation of ineligibility
+          #
+          #   @param reason [Symbol, Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason] Reason code for ineligibility
+
+          # Reason code for ineligibility
+          #
+          # @see Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide#reason
+          module Reason
+            extend Knockapi::Internal::Type::Enum
+
+            GUIDE_NOT_ACTIVE = :guide_not_active
+            MARKED_AS_ARCHIVED = :marked_as_archived
+            TARGET_CONDITIONS_NOT_MET = :target_conditions_not_met
+            NOT_IN_TARGET_AUDIENCE = :not_in_target_audience
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end

data/lib/knockapi/version.rb

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

data/rbi/knockapi/models/condition.rbi

@@ -85,9 +85,9 @@ module Knockapi
           T.let(:is_timestamp, Knockapi::Condition::Operator::TaggedSymbol)
         IS_NOT_TIMESTAMP =
           T.let(:is_not_timestamp, Knockapi::Condition::Operator::TaggedSymbol)
-        IS_TIMESTAMP_AFTER =
+        IS_TIMESTAMP_ON_OR_AFTER =
           T.let(
-            :is_timestamp_after,
+            :is_timestamp_on_or_after,
             Knockapi::Condition::Operator::TaggedSymbol
           )
         IS_TIMESTAMP_BEFORE =

data/rbi/knockapi/models/users/guide_get_channel_response.rbi

@@ -34,6 +34,16 @@ module Knockapi
         end
         attr_accessor :guide_groups
 
+        # Markers for guides the user is not eligible to see.
+        sig do
+          returns(
+            T::Array[
+              Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide
+            ]
+          )
+        end
+        attr_accessor :ineligible_guides
+
         # A response for a list of guides.
         sig do
           params(
@@ -45,6 +55,10 @@ module Knockapi
             guide_groups:
               T::Array[
                 Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup::OrHash
+              ],
+            ineligible_guides:
+              T::Array[
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::OrHash
               ]
           ).returns(T.attached_class)
         end
@@ -54,7 +68,9 @@ module Knockapi
           # A map of guide group keys to their last display timestamps.
           guide_group_display_logs:,
           # A list of guide groups with their display sequences and intervals.
-          guide_groups:
+          guide_groups:,
+          # Markers for guides the user is not eligible to see.
+          ineligible_guides:
         )
         end
 
@@ -69,6 +85,10 @@ module Knockapi
               guide_groups:
                 T::Array[
                   Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup
+                ],
+              ineligible_guides:
+                T::Array[
+                  Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide
                 ]
             }
           )
@@ -650,6 +670,108 @@ module Knockapi
           def to_hash
           end
         end
+
+        class IneligibleGuide < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # The guide's key identifier
+          sig { returns(String) }
+          attr_accessor :key
+
+          # Human-readable explanation of ineligibility
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Reason code for ineligibility
+          sig do
+            returns(
+              Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+            )
+          end
+          attr_accessor :reason
+
+          sig do
+            params(
+              key: String,
+              message: String,
+              reason:
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The guide's key identifier
+            key:,
+            # Human-readable explanation of ineligibility
+            message:,
+            # Reason code for ineligibility
+            reason:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                key: String,
+                message: String,
+                reason:
+                  Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Reason code for ineligibility
+          module Reason
+            extend Knockapi::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GUIDE_NOT_ACTIVE =
+              T.let(
+                :guide_not_active,
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+              )
+            MARKED_AS_ARCHIVED =
+              T.let(
+                :marked_as_archived,
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+              )
+            TARGET_CONDITIONS_NOT_MET =
+              T.let(
+                :target_conditions_not_met,
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+              )
+            NOT_IN_TARGET_AUDIENCE =
+              T.let(
+                :not_in_target_audience,
+                Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

data/sig/knockapi/models/condition.rbs

@@ -40,7 +40,7 @@ module Knockapi
         | :contains_all
         | :is_timestamp
         | :is_not_timestamp
-        | :is_timestamp_after
+        | :is_timestamp_on_or_after
         | :is_timestamp_before
         | :is_timestamp_between
         | :is_audience_member
@@ -62,7 +62,7 @@ module Knockapi
         CONTAINS_ALL: :contains_all
         IS_TIMESTAMP: :is_timestamp
         IS_NOT_TIMESTAMP: :is_not_timestamp
-        IS_TIMESTAMP_AFTER: :is_timestamp_after
+        IS_TIMESTAMP_ON_OR_AFTER: :is_timestamp_on_or_after
         IS_TIMESTAMP_BEFORE: :is_timestamp_before
         IS_TIMESTAMP_BETWEEN: :is_timestamp_between
         IS_AUDIENCE_MEMBER: :is_audience_member

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

@@ -5,7 +5,8 @@ module Knockapi
         {
           entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
           guide_group_display_logs: ::Hash[Symbol, Time],
-          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup],
+          ineligible_guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide]
         }
 
       class GuideGetChannelResponse < Knockapi::Internal::Type::BaseModel
@@ -15,16 +16,20 @@ module Knockapi
 
         attr_accessor guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
 
+        attr_accessor ineligible_guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide]
+
         def initialize: (
           entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
           guide_group_display_logs: ::Hash[Symbol, Time],
-          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup],
+          ineligible_guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide]
         ) -> void
 
         def to_hash: -> {
           entries: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::Entry],
           guide_group_display_logs: ::Hash[Symbol, Time],
-          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup]
+          guide_groups: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::GuideGroup],
+          ineligible_guides: ::Array[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide]
         }
 
         type entry =
@@ -343,6 +348,50 @@ module Knockapi
             updated_at: Time
           }
         end
+
+        type ineligible_guide =
+          {
+            key: String,
+            message: String,
+            reason: Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason
+          }
+
+        class IneligibleGuide < Knockapi::Internal::Type::BaseModel
+          attr_accessor key: String
+
+          attr_accessor message: String
+
+          attr_accessor reason: Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason
+
+          def initialize: (
+            key: String,
+            message: String,
+            reason: Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason
+          ) -> void
+
+          def to_hash: -> {
+            key: String,
+            message: String,
+            reason: Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason
+          }
+
+          type reason =
+            :guide_not_active
+            | :marked_as_archived
+            | :target_conditions_not_met
+            | :not_in_target_audience
+
+          module Reason
+            extend Knockapi::Internal::Type::Enum
+
+            GUIDE_NOT_ACTIVE: :guide_not_active
+            MARKED_AS_ARCHIVED: :marked_as_archived
+            TARGET_CONDITIONS_NOT_MET: :target_conditions_not_met
+            NOT_IN_TARGET_AUDIENCE: :not_in_target_audience
+
+            def self?.values: -> ::Array[Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason]
+          end
+        end
       end
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.25.1
+  version: 1.26.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-05 00:00:00.000000000 Z
+date: 2026-01-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement