knockapi 1.42.0 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb0347a9022e3737e27a4cda9592a99130fe4e1cf701621d5fd23a96b319893
-  data.tar.gz: da410e0b30cc88ec3c43f541e0799e4e76e75c9e7539f10e2cf5b0f4fe7616fa
+  metadata.gz: e007375ac8e8c2b288f7606d5c046a1cfec0d4dfec30821096fc9e3efca07177
+  data.tar.gz: 7c3d64e0447482098348e1c2625fcc1588b7723ee7b07001f9aa42dc58a316d2
 SHA512:
-  metadata.gz: 67f738c898c02679260b948b981d7907cdcf10a419e320485ed5a217b649387086cc6e9603bcb736b14a2389f727d9ad8689328a7d993cde1761448adb5378da
-  data.tar.gz: 1e78c6da32be0c18670b0e6f61d1e21f02d51903e670c07df8a3627a7f51086e54167310b232371e91d06d09d3a0e0f7262de08ec56bdf99b5a827a28afcad9f
+  metadata.gz: aa165c50a85d40c45bb1a730a2284ff0974f68216f2385c2f063eeb9a778edb5e82968ca7d83f54dd015f527042b78b2690f1ab330dbfdf04b704e74fc93afdf
+  data.tar.gz: b7306040d31ad026f10990e569d08f0fc6ead31d2124b331d043cc1abf8ca9f8ca977e0e406edcb77e0a1b7b4b0aac3bf4f7d1cb0a2d3b8ecd0b6fa86b1eac3a

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.43.0](https://github.com/knocklabs/knock-ruby/compare/v1.42.0...v1.43.0) (2026-10-19)
+
+
+### Features
+
+* List users can now be sorted with the new order parameter (v0.1.1781) ([8c9a7f1](https://github.com/knocklabs/knock-ruby/commit/8c9a7f13bcfd0ddc39c5f99aeb08b3dc68eb297b))
+* update api spec to v0.1.1757 ([cfb7fdc](https://github.com/knocklabs/knock-ruby/commit/cfb7fdc332b33ec609b7c6f98617c7403afb73dd))
+* update api spec to v0.1.1759 ([0df4223](https://github.com/knocklabs/knock-ruby/commit/0df422360adf6690fab64ff6e8da2cdefaa28d8f))
+* update api spec to v0.1.1760 ([608426f](https://github.com/knocklabs/knock-ruby/commit/608426f5ce331a9e45b324978d8e2df35afa2e3c))
+
+
+### Bug Fixes
+
+* Messages now report branch path, and listUsers no longer accepts the order parameter (v0.1.1782) ([43415ec](https://github.com/knocklabs/knock-ruby/commit/43415ec87750332bc1d4226eec27191ef75b8ec6))
+
 ## [1.42.0](https://github.com/knocklabs/knock-ruby/compare/v1.41.0...v1.42.0) (2026-09-17)
 
 

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

data/lib/knockapi/models/message.rb

@@ -250,6 +250,16 @@ module Knockapi
         #   @return [String]
         required :version_id, String
 
+        # @!attribute branch_path
+        #   The branch ancestry of the step that generated the message, outermost first.
+        #   Each segment is the branching step and the branch taken. Omitted when the step
+        #   is not nested under a branch.
+        #
+        #   @return [Array<Knockapi::Models::Message::Source::BranchPath>, nil]
+        optional :branch_path,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Message::Source::BranchPath] },
+                 nil?: true
+
         # @!attribute step_ref
         #   The step reference for the step in the workflow that generated the message.
         #
@@ -276,7 +286,7 @@ module Knockapi
         #   @return [String, nil]
         optional :workflow_run_id, String, nil?: true
 
-        # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil, type: nil, workflow_recipient_run_id: nil, workflow_run_id: nil)
+        # @!method initialize(_typename:, categories:, key:, version_id:, branch_path: nil, step_ref: nil, type: nil, workflow_recipient_run_id: nil, workflow_run_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Knockapi::Models::Message::Source} for more details.
         #
@@ -290,6 +300,8 @@ module Knockapi
         #
         #   @param version_id [String] The ID of the version of the workflow or guide that triggered the message.
         #
+        #   @param branch_path [Array<Knockapi::Models::Message::Source::BranchPath>, nil] The branch ancestry of the step that generated the message, outermost first. Eac
+        #
         #   @param step_ref [String, nil] The step reference for the step in the workflow that generated the message.
         #
         #   @param type [Symbol, Knockapi::Models::Message::Source::Type] Whether this message was generated from a workflow, broadcast, or guide.
@@ -298,6 +310,33 @@ module Knockapi
         #
         #   @param workflow_run_id [String, nil] The unique identifier for the workflow run that generated this message. Only pre
 
+        class BranchPath < Knockapi::Internal::Type::BaseModel
+          # @!attribute branch_id
+          #   The ID of the branch taken.
+          #
+          #   @return [String]
+          required :branch_id, String
+
+          # @!attribute step_ref
+          #   The reference of the branching step.
+          #
+          #   @return [String]
+          required :step_ref, String
+
+          # @!attribute step_type
+          #   The type of the branching step.
+          #
+          #   @return [String]
+          required :step_type, String
+
+          # @!method initialize(branch_id:, step_ref:, step_type:)
+          #   @param branch_id [String] The ID of the branch taken.
+          #
+          #   @param step_ref [String] The reference of the branching step.
+          #
+          #   @param step_type [String] The type of the branching step.
+        end
+
         # Whether this message was generated from a workflow, broadcast, or guide.
         #
         # @see Knockapi::Models::Message::Source#type

data/lib/knockapi/resources/users.rb

@@ -29,7 +29,7 @@ module Knockapi
       # {Knockapi::Models::UserUpdateParams} for more details.
       #
       # Create or update a user with the provided identification data. When you identify
-      # an existing user, the system merges the properties you specific with what is
+      # an existing user, the system merges the properties you specify with what is
       # currently set on the user, updating only the fields included in your requests.
       #
       # @overload update(user_id, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil, request_options: {})

data/lib/knockapi/version.rb

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

data/rbi/knockapi/models/message.rbi

@@ -324,6 +324,14 @@ module Knockapi
         sig { returns(String) }
         attr_accessor :version_id
 
+        # The branch ancestry of the step that generated the message, outermost first.
+        # Each segment is the branching step and the branch taken. Omitted when the step
+        # is not nested under a branch.
+        sig do
+          returns(T.nilable(T::Array[Knockapi::Message::Source::BranchPath]))
+        end
+        attr_accessor :branch_path
+
         # The step reference for the step in the workflow that generated the message.
         sig { returns(T.nilable(String)) }
         attr_accessor :step_ref
@@ -354,6 +362,10 @@ module Knockapi
             categories: T::Array[String],
             key: String,
             version_id: String,
+            branch_path:
+              T.nilable(
+                T::Array[Knockapi::Message::Source::BranchPath::OrHash]
+              ),
             step_ref: T.nilable(String),
             type: Knockapi::Message::Source::Type::OrSymbol,
             workflow_recipient_run_id: T.nilable(String),
@@ -368,6 +380,10 @@ module Knockapi
           key:,
           # The ID of the version of the workflow or guide that triggered the message.
           version_id:,
+          # The branch ancestry of the step that generated the message, outermost first.
+          # Each segment is the branching step and the branch taken. Omitted when the step
+          # is not nested under a branch.
+          branch_path: nil,
           # The step reference for the step in the workflow that generated the message.
           step_ref: nil,
           # Whether this message was generated from a workflow, broadcast, or guide.
@@ -388,6 +404,8 @@ module Knockapi
               categories: T::Array[String],
               key: String,
               version_id: String,
+              branch_path:
+                T.nilable(T::Array[Knockapi::Message::Source::BranchPath]),
               step_ref: T.nilable(String),
               type: Knockapi::Message::Source::Type::TaggedSymbol,
               workflow_recipient_run_id: T.nilable(String),
@@ -398,6 +416,53 @@ module Knockapi
         def to_hash
         end
 
+        class BranchPath < Knockapi::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Knockapi::Message::Source::BranchPath,
+                Knockapi::Internal::AnyHash
+              )
+            end
+
+          # The ID of the branch taken.
+          sig { returns(String) }
+          attr_accessor :branch_id
+
+          # The reference of the branching step.
+          sig { returns(String) }
+          attr_accessor :step_ref
+
+          # The type of the branching step.
+          sig { returns(String) }
+          attr_accessor :step_type
+
+          sig do
+            params(
+              branch_id: String,
+              step_ref: String,
+              step_type: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the branch taken.
+            branch_id:,
+            # The reference of the branching step.
+            step_ref:,
+            # The type of the branching step.
+            step_type:
+          )
+          end
+
+          sig do
+            override.returns(
+              { branch_id: String, step_ref: String, step_type: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
         # Whether this message was generated from a workflow, broadcast, or guide.
         module Type
           extend Knockapi::Internal::Type::Enum

data/rbi/knockapi/resources/users.rbi

@@ -26,7 +26,7 @@ module Knockapi
       attr_reader :preference_center
 
       # Create or update a user with the provided identification data. When you identify
-      # an existing user, the system merges the properties you specific with what is
+      # an existing user, the system merges the properties you specify with what is
       # currently set on the user, updating only the fields included in your requests.
       sig do
         params(

data/sig/knockapi/models/message.rbs

@@ -153,6 +153,7 @@ module Knockapi
           categories: ::Array[String],
           key: String,
           version_id: String,
+          branch_path: ::Array[Knockapi::Message::Source::BranchPath]?,
           step_ref: String?,
           type: Knockapi::Models::Message::Source::type_,
           workflow_recipient_run_id: String?,
@@ -168,6 +169,8 @@ module Knockapi
 
         attr_accessor version_id: String
 
+        attr_accessor branch_path: ::Array[Knockapi::Message::Source::BranchPath]?
+
         attr_accessor step_ref: String?
 
         attr_reader type: Knockapi::Models::Message::Source::type_?
@@ -185,6 +188,7 @@ module Knockapi
           categories: ::Array[String],
           key: String,
           version_id: String,
+          ?branch_path: ::Array[Knockapi::Message::Source::BranchPath]?,
           ?step_ref: String?,
           ?type: Knockapi::Models::Message::Source::type_,
           ?workflow_recipient_run_id: String?,
@@ -196,12 +200,36 @@ module Knockapi
           categories: ::Array[String],
           key: String,
           version_id: String,
+          branch_path: ::Array[Knockapi::Message::Source::BranchPath]?,
           step_ref: String?,
           type: Knockapi::Models::Message::Source::type_,
           workflow_recipient_run_id: String?,
           workflow_run_id: String?
         }
 
+        type branch_path =
+          { branch_id: String, step_ref: String, step_type: String }
+
+        class BranchPath < Knockapi::Internal::Type::BaseModel
+          attr_accessor branch_id: String
+
+          attr_accessor step_ref: String
+
+          attr_accessor step_type: String
+
+          def initialize: (
+            branch_id: String,
+            step_ref: String,
+            step_type: String
+          ) -> void
+
+          def to_hash: -> {
+            branch_id: String,
+            step_ref: String,
+            step_type: String
+          }
+        end
+
         type type_ = :broadcast | :workflow | :guide
 
         module Type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.42.0
+  version: 1.43.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi