knockapi 1.28.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a442736b2460b038455a36525edbb82ed5c11e17e026aaa909ec0e6cb0a1f1
-  data.tar.gz: e007cb42e465cfadcddac8988508d456bc260fe956adcc490a0d665f5b20c129
+  metadata.gz: 968b7c6cd1bcba26164014728aac65bd2adbd9ece73f8b98f2646cded91ebe4d
+  data.tar.gz: c0d80064448643c1041421596c5467f80d33f1e94e3b0876f5ecd39bad794023
 SHA512:
-  metadata.gz: 1159248a48a06c4e456157b3a335bd71984979a2c4d5a5956f3eb6505a29653b01c5f35c768d04adb6285882e9b4f4a06d7d6760bb030d1e1174abc78e5b1f01
-  data.tar.gz: 0ba8d28798f8222322b4fde1a681fa12d8650d3e236fec5f934a80ece6d9c731ff0348ec7a5a2719246e33b64a69b5bc34f075cf9e1312ff781fc1d9d87ddd9b
+  metadata.gz: 1ffa2a84f9650b45de08419cc9976a1679fca4cc0864785a40f5a3a98c73350178820282b755e3537e5e3f146e81e81dc442738bac78c9f69bb2b8296e06ac2d
+  data.tar.gz: 65cb415912b9e29467ea9c31f2f1f50bd946838b99353a73f8f33b9b4de5f5be6dbd6a6556843e516b71bff4b5c7320b364d5983853563e1750a440905c3aa40

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.30.0 (2026-01-29)
+
+Full Changelog: [v1.29.0...v1.30.0](https://github.com/knocklabs/knock-ruby/compare/v1.29.0...v1.30.0)
+
+### Features
+
+* **api:** api update ([5082dcb](https://github.com/knocklabs/knock-ruby/commit/5082dcb9d09ef3a3bc3d496f94fd31ee018ac4ee))
+* **api:** api update ([41c7881](https://github.com/knocklabs/knock-ruby/commit/41c78811817cdc595674b56381e396b8a5c6f96a))
+* **api:** api update ([e4c9e2b](https://github.com/knocklabs/knock-ruby/commit/e4c9e2bbf5664f057addd6c2b8013c11de97f193))
+* **api:** api update ([3ba6399](https://github.com/knocklabs/knock-ruby/commit/3ba63996dab0c2047a0e019a0bfd844513e0600f))
+* **api:** api update ([3a1d05d](https://github.com/knocklabs/knock-ruby/commit/3a1d05d96b3dbf0abe14f9f4c58e2b16f2ffbbd0))
+
+## 1.29.0 (2026-01-23)
+
+Full Changelog: [v1.28.0...v1.29.0](https://github.com/knocklabs/knock-ruby/compare/v1.28.0...v1.29.0)
+
+### Features
+
+* **api:** api update ([bea8ceb](https://github.com/knocklabs/knock-ruby/commit/bea8cebbd2499815f0117dc68193e7b1cac3545e))
+
 ## 1.28.0 (2026-01-23)
 
 Full Changelog: [v1.27.0...v1.28.0](https://github.com/knocklabs/knock-ruby/compare/v1.27.0...v1.28.0)

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.28.0"
+gem "knockapi", "~> 1.30.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/models/audience_add_members_params.rb

@@ -20,10 +20,13 @@ module Knockapi
 
       class Member < Knockapi::Internal::Type::BaseModel
         # @!attribute user
-        #   An object containing the user's ID.
+        #   A set of parameters to inline-identify a user with. Inline identifying the user
+        #   will ensure that the user is available before the request is executed in Knock.
+        #   It will perform an upsert for the user you're supplying, replacing any
+        #   properties specified.
         #
-        #   @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
-        required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }
+        #   @return [Knockapi::Models::InlineIdentifyUserRequest]
+        required :user, -> { Knockapi::InlineIdentifyUserRequest }
 
         # @!attribute tenant
         #   The unique identifier for the tenant.
@@ -32,25 +35,14 @@ module Knockapi
         optional :tenant, String, nil?: true
 
         # @!method initialize(user:, tenant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::AudienceAddMembersParams::Member} for more details.
+        #
         #   An audience member.
         #
-        #   @param user [Knockapi::Models::AudienceAddMembersParams::Member::User] An object containing the user's ID.
+        #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
         #
         #   @param tenant [String, nil] The unique identifier for the tenant.
-
-        # @see Knockapi::Models::AudienceAddMembersParams::Member#user
-        class User < Knockapi::Internal::Type::BaseModel
-          # @!attribute id
-          #   The unique identifier of the user.
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!method initialize(id: nil)
-          #   An object containing the user's ID.
-          #
-          #   @param id [String] The unique identifier of the user.
-        end
       end
     end
   end

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -20,10 +20,13 @@ module Knockapi
 
       class Member < Knockapi::Internal::Type::BaseModel
         # @!attribute user
-        #   An object containing the user's ID.
+        #   A set of parameters to inline-identify a user with. Inline identifying the user
+        #   will ensure that the user is available before the request is executed in Knock.
+        #   It will perform an upsert for the user you're supplying, replacing any
+        #   properties specified.
         #
-        #   @return [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
-        required :user, -> { Knockapi::AudienceRemoveMembersParams::Member::User }
+        #   @return [Knockapi::Models::InlineIdentifyUserRequest]
+        required :user, -> { Knockapi::InlineIdentifyUserRequest }
 
         # @!attribute tenant
         #   The unique identifier for the tenant.
@@ -32,25 +35,14 @@ module Knockapi
         optional :tenant, String, nil?: true
 
         # @!method initialize(user:, tenant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::AudienceRemoveMembersParams::Member} for more details.
+        #
         #   An audience member.
         #
-        #   @param user [Knockapi::Models::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
+        #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
         #
         #   @param tenant [String, nil] The unique identifier for the tenant.
-
-        # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
-        class User < Knockapi::Internal::Type::BaseModel
-          # @!attribute id
-          #   The unique identifier of the user.
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!method initialize(id: nil)
-          #   An object containing the user's ID.
-          #
-          #   @param id [String] The unique identifier of the user.
-        end
       end
     end
   end

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

@@ -164,10 +164,18 @@ module Knockapi
             #   @return [String, nil]
             optional :pathname, String
 
-            # @!method initialize(directive: nil, pathname: nil)
+            # @!attribute search
+            #   The search query params to match
+            #
+            #   @return [String, nil]
+            optional :search, String
+
+            # @!method initialize(directive: nil, pathname: nil, search: nil)
             #   @param directive [String] The directive for the URL pattern ('allow' or 'block')
             #
             #   @param pathname [String] The pathname pattern to match (supports wildcards like /\*)
+            #
+            #   @param search [String] The search query params to match
           end
 
           class ActivationURLRule < Knockapi::Internal::Type::BaseModel
@@ -178,7 +186,7 @@ module Knockapi
             optional :argument, String
 
             # @!attribute directive
-            #   The directive for the URL pattern ('allow' or 'block')
+            #   The directive for the URL rule ('allow' or 'block')
             #
             #   @return [String, nil]
             optional :directive, String
@@ -198,7 +206,7 @@ module Knockapi
             # @!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 directive [String] The directive for the URL rule ('allow' or 'block')
             #
             #   @param operator [String] The comparison operator ('contains' or 'equal_to')
             #

data/lib/knockapi/resources/users/feeds.rb

@@ -43,6 +43,9 @@ module Knockapi
         #   along with a user token.
         # - This endpoint’s rate limit is always scoped per-user and per-environment. This
         #   is true even for requests made without a signed user token.
+        # - Any [attachments](/integrations/email/attachments) present in trigger data are
+        #   automatically excluded from both the `data` and `activities` fields of
+        #   `UserInAppFeedResponse`.
         #
         # @overload list_items(user_id, id, after: nil, archived: nil, before: nil, has_tenant: nil, locale: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
         #

data/lib/knockapi/version.rb

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

data/rbi/knockapi/models/audience_add_members_params.rbi

@@ -48,15 +48,14 @@ module Knockapi
             )
           end
 
-        # An object containing the user's ID.
-        sig { returns(Knockapi::AudienceAddMembersParams::Member::User) }
+        # A set of parameters to inline-identify a user with. Inline identifying the user
+        # will ensure that the user is available before the request is executed in Knock.
+        # It will perform an upsert for the user you're supplying, replacing any
+        # properties specified.
+        sig { returns(Knockapi::InlineIdentifyUserRequest) }
         attr_reader :user
 
-        sig do
-          params(
-            user: Knockapi::AudienceAddMembersParams::Member::User::OrHash
-          ).void
-        end
+        sig { params(user: Knockapi::InlineIdentifyUserRequest::OrHash).void }
         attr_writer :user
 
         # The unique identifier for the tenant.
@@ -66,12 +65,15 @@ module Knockapi
         # An audience member.
         sig do
           params(
-            user: Knockapi::AudienceAddMembersParams::Member::User::OrHash,
+            user: Knockapi::InlineIdentifyUserRequest::OrHash,
             tenant: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
-          # An object containing the user's ID.
+          # A set of parameters to inline-identify a user with. Inline identifying the user
+          # will ensure that the user is available before the request is executed in Knock.
+          # It will perform an upsert for the user you're supplying, replacing any
+          # properties specified.
           user:,
           # The unique identifier for the tenant.
           tenant: nil
@@ -81,42 +83,13 @@ module Knockapi
         sig do
           override.returns(
             {
-              user: Knockapi::AudienceAddMembersParams::Member::User,
+              user: Knockapi::InlineIdentifyUserRequest,
               tenant: T.nilable(String)
             }
           )
         end
         def to_hash
         end
-
-        class User < Knockapi::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Knockapi::AudienceAddMembersParams::Member::User,
-                Knockapi::Internal::AnyHash
-              )
-            end
-
-          # The unique identifier of the user.
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # An object containing the user's ID.
-          sig { params(id: String).returns(T.attached_class) }
-          def self.new(
-            # The unique identifier of the user.
-            id: nil
-          )
-          end
-
-          sig { override.returns({ id: String }) }
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/knockapi/models/audience_remove_members_params.rbi

@@ -52,15 +52,14 @@ module Knockapi
             )
           end
 
-        # An object containing the user's ID.
-        sig { returns(Knockapi::AudienceRemoveMembersParams::Member::User) }
+        # A set of parameters to inline-identify a user with. Inline identifying the user
+        # will ensure that the user is available before the request is executed in Knock.
+        # It will perform an upsert for the user you're supplying, replacing any
+        # properties specified.
+        sig { returns(Knockapi::InlineIdentifyUserRequest) }
         attr_reader :user
 
-        sig do
-          params(
-            user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash
-          ).void
-        end
+        sig { params(user: Knockapi::InlineIdentifyUserRequest::OrHash).void }
         attr_writer :user
 
         # The unique identifier for the tenant.
@@ -70,12 +69,15 @@ module Knockapi
         # An audience member.
         sig do
           params(
-            user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash,
+            user: Knockapi::InlineIdentifyUserRequest::OrHash,
             tenant: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
-          # An object containing the user's ID.
+          # A set of parameters to inline-identify a user with. Inline identifying the user
+          # will ensure that the user is available before the request is executed in Knock.
+          # It will perform an upsert for the user you're supplying, replacing any
+          # properties specified.
           user:,
           # The unique identifier for the tenant.
           tenant: nil
@@ -85,42 +87,13 @@ module Knockapi
         sig do
           override.returns(
             {
-              user: Knockapi::AudienceRemoveMembersParams::Member::User,
+              user: Knockapi::InlineIdentifyUserRequest,
               tenant: T.nilable(String)
             }
           )
         end
         def to_hash
         end
-
-        class User < Knockapi::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Knockapi::AudienceRemoveMembersParams::Member::User,
-                Knockapi::Internal::AnyHash
-              )
-            end
-
-          # The unique identifier of the user.
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # An object containing the user's ID.
-          sig { params(id: String).returns(T.attached_class) }
-          def self.new(
-            # The unique identifier of the user.
-            id: nil
-          )
-          end
-
-          sig { override.returns({ id: String }) }
-          def to_hash
-          end
-        end
       end
     end
   end

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

@@ -343,20 +343,35 @@ module Knockapi
             sig { params(pathname: String).void }
             attr_writer :pathname
 
+            # The search query params to match
+            sig { returns(T.nilable(String)) }
+            attr_reader :search
+
+            sig { params(search: String).void }
+            attr_writer :search
+
             sig do
-              params(directive: String, pathname: String).returns(
-                T.attached_class
-              )
+              params(
+                directive: String,
+                pathname: String,
+                search: String
+              ).returns(T.attached_class)
             end
             def self.new(
               # The directive for the URL pattern ('allow' or 'block')
               directive: nil,
               # The pathname pattern to match (supports wildcards like /\*)
-              pathname: nil
+              pathname: nil,
+              # The search query params to match
+              search: nil
             )
             end
 
-            sig { override.returns({ directive: String, pathname: String }) }
+            sig do
+              override.returns(
+                { directive: String, pathname: String, search: String }
+              )
+            end
             def to_hash
             end
           end
@@ -377,7 +392,7 @@ module Knockapi
             sig { params(argument: String).void }
             attr_writer :argument
 
-            # The directive for the URL pattern ('allow' or 'block')
+            # The directive for the URL rule ('allow' or 'block')
             sig { returns(T.nilable(String)) }
             attr_reader :directive
 
@@ -409,7 +424,7 @@ module Knockapi
             def self.new(
               # The value to compare against
               argument: nil,
-              # The directive for the URL pattern ('allow' or 'block')
+              # The directive for the URL rule ('allow' or 'block')
               directive: nil,
               # The comparison operator ('contains' or 'equal_to')
               operator: nil,

data/rbi/knockapi/resources/users/feeds.rbi

@@ -35,6 +35,9 @@ module Knockapi
         #   along with a user token.
         # - This endpoint’s rate limit is always scoped per-user and per-environment. This
         #   is true even for requests made without a signed user token.
+        # - Any [attachments](/integrations/email/attachments) present in trigger data are
+        #   automatically excluded from both the `data` and `activities` fields of
+        #   `UserInAppFeedResponse`.
         sig do
           params(
             user_id: String,

data/sig/knockapi/models/audience_add_members_params.rbs

@@ -21,37 +21,22 @@ module Knockapi
       }
 
       type member =
-        {
-          user: Knockapi::AudienceAddMembersParams::Member::User,
-          tenant: String?
-        }
+        { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
 
       class Member < Knockapi::Internal::Type::BaseModel
-        attr_accessor user: Knockapi::AudienceAddMembersParams::Member::User
+        attr_accessor user: Knockapi::InlineIdentifyUserRequest
 
         attr_accessor tenant: String?
 
         def initialize: (
-          user: Knockapi::AudienceAddMembersParams::Member::User,
+          user: Knockapi::InlineIdentifyUserRequest,
           ?tenant: String?
         ) -> void
 
         def to_hash: -> {
-          user: Knockapi::AudienceAddMembersParams::Member::User,
+          user: Knockapi::InlineIdentifyUserRequest,
           tenant: String?
         }
-
-        type user = { id: String }
-
-        class User < Knockapi::Internal::Type::BaseModel
-          attr_reader id: String?
-
-          def id=: (String) -> String
-
-          def initialize: (?id: String) -> void
-
-          def to_hash: -> { id: String }
-        end
       end
     end
   end

data/sig/knockapi/models/audience_remove_members_params.rbs

@@ -21,37 +21,22 @@ module Knockapi
       }
 
       type member =
-        {
-          user: Knockapi::AudienceRemoveMembersParams::Member::User,
-          tenant: String?
-        }
+        { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
 
       class Member < Knockapi::Internal::Type::BaseModel
-        attr_accessor user: Knockapi::AudienceRemoveMembersParams::Member::User
+        attr_accessor user: Knockapi::InlineIdentifyUserRequest
 
         attr_accessor tenant: String?
 
         def initialize: (
-          user: Knockapi::AudienceRemoveMembersParams::Member::User,
+          user: Knockapi::InlineIdentifyUserRequest,
           ?tenant: String?
         ) -> void
 
         def to_hash: -> {
-          user: Knockapi::AudienceRemoveMembersParams::Member::User,
+          user: Knockapi::InlineIdentifyUserRequest,
           tenant: String?
         }
-
-        type user = { id: String }
-
-        class User < Knockapi::Internal::Type::BaseModel
-          attr_reader id: String?
-
-          def id=: (String) -> String
-
-          def initialize: (?id: String) -> void
-
-          def to_hash: -> { id: String }
-        end
       end
     end
   end

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

@@ -140,7 +140,8 @@ module Knockapi
             updated_at: Time
           }
 
-          type activation_url_pattern = { directive: String, pathname: String }
+          type activation_url_pattern =
+            { directive: String, pathname: String, search: String }
 
           class ActivationURLPattern < Knockapi::Internal::Type::BaseModel
             attr_reader directive: String?
@@ -151,9 +152,21 @@ module Knockapi
 
             def pathname=: (String) -> String
 
-            def initialize: (?directive: String, ?pathname: String) -> void
+            attr_reader search: String?
 
-            def to_hash: -> { directive: String, pathname: String }
+            def search=: (String) -> String
+
+            def initialize: (
+              ?directive: String,
+              ?pathname: String,
+              ?search: String
+            ) -> void
+
+            def to_hash: -> {
+              directive: String,
+              pathname: String,
+              search: String
+            }
           end
 
           type activation_url_rule =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-23 00:00:00.000000000 Z
+date: 2026-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi