trycourier 6.12.0 → 6.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26943393679593de932be9962339164bdfdd09c63642b7d27a6f38ee061c8bfd
-  data.tar.gz: b8ddcc3c806c9ffa4246f53f8dd533a284214be239995b02acd7b1be6c2cbb36
+  metadata.gz: adeed3b02658fe1c360d234bbd24ce3c2c3dcd34637b766514178b3ea473cbb5
+  data.tar.gz: dfc4345ec2d9db5bbd66bca95fae14eb11fb5a8a19d8afa7b7493a0325786583
 SHA512:
-  metadata.gz: b80eb41483e2b7f9d19780b0468709eed4c1ed590264cec819ef26ad25cdae82a82674551d83b404de8876b30e73671bcc649ac03729a867b1231b7dc8c30d10
-  data.tar.gz: f3659cecd8aca744f5d4e4b5831bbc64fd44b65f86f379a5e261d12245f4ba51e624b600ced5f69433890c89a30bdb9a1b9b1645ac217f43cb3e73d559c5f844
+  metadata.gz: 0e7711edd3bc7c6b0602ed7e8545cadadf2c10727de043474aec07e7ad121b1bfe324ac8d8c11efa77a15082a600c3ac26725146198359876a16b49178979b5d
+  data.tar.gz: 9cf63697464b8a65544002c1c50552c6a8c835012fad7cecd94373f5fbba7233361fde3bf16f41c4919409f6f5892092d12ea45f5d369bae960d0afc5ce017a1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [6.13.0](https://github.com/trycourier/courier-ruby/compare/v6.12.0...v6.13.0) (2026-10-23)
+
+
+### Features
+
+* **api:** journey run steps return error and skip_reason ([#179](https://github.com/trycourier/courier-ruby/issues/179)) ([d5a8120](https://github.com/trycourier/courier-ruby/commit/d5a8120a93e5524ea27c5c075819a9f6d2a8b9f4))
+
+
+### Chores
+
+* **api:** regenerate SDK ([#181](https://github.com/trycourier/courier-ruby/issues/181)) ([eadaf17](https://github.com/trycourier/courier-ruby/commit/eadaf17a4f75bd8d8825522d213eecb513b3c872))
+
 ## [6.12.0](https://github.com/trycourier/courier-ruby/compare/v6.11.3...v6.12.0) (2026-10-21)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 6.12.0"
+gem "trycourier", "~> 6.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/models/journey_conditions_field.rb

@@ -14,7 +14,7 @@ module Courier
       #   `starts with`, `ends with`, `greater than`, `greater than or equal`,
       #   `less than`, `less than or equal`, `was`, `was not`.
       #
-      #   Example: `["user.tier", "is equal", "gold"]`.
+      #   Example: `["profile.tier", "is equal", "gold"]`.
       #
       #   `was` / `was not` compare a `send_status.<nodeId>` path (referencing
       #   an earlier send node's node id) against one of `SENT`, `DELIVERED`,
@@ -29,9 +29,9 @@ module Courier
       # - Unary form (2 elements): `[path, operator]` where `operator` is
       #   one of `exists`, `does not exist`.
       #
-      #   Example: `["user.email", "exists"]`.
+      #   Example: `["profile.email", "exists"]`.
       #
-      # The first element is a non-empty dot-path. The second element is the operator (must come from one of the two operator sets above). For the binary form, the third element is the comparison value (string). Runtime validation of the operator value and arity is performed by the backend; SDKs surface this as a string list.
+      # The first element is a non-empty dot-path that starts with `data.`, `profile.`, `tenant.` (only when the trigger sets a tenant), or `send_status.<nodeId>`. The second element is the operator (must come from one of the two operator sets above). For the binary form, the third element is the comparison value (string). Runtime validation of the operator value and arity is performed by the backend; SDKs surface this as a string list.
       variant -> { Courier::JourneyConditionAtom }
 
       # A leaf condition group. Exactly one of `AND` or `OR` must be present at runtime; each is a list of `JourneyConditionAtom` tuples.

data/lib/courier/models/journey_run_step.rb

@@ -9,6 +9,19 @@ module Courier
       #   @return [String]
       required :action, String
 
+      # @!attribute error
+      #   Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+      #
+      #   @return [Courier::Models::JourneyRunStep::Error, nil]
+      required :error, -> { Courier::JourneyRunStep::Error }, nil?: true
+
+      # @!attribute skip_reason
+      #   Why the step was skipped, e.g. `Node conditions not met`. Set when `status` is
+      #   `SKIPPED`, `null` otherwise.
+      #
+      #   @return [String, nil]
+      required :skip_reason, String, nil?: true
+
       # @!attribute status
       #   The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`.
       #   Not an enum — new values have been added before.
@@ -42,7 +55,7 @@ module Courier
       #   @return [String, nil]
       optional :updated_at, String
 
-      # @!method initialize(action:, status:, created_at: nil, message_id: nil, node_id: nil, updated_at: nil)
+      # @!method initialize(action:, error:, skip_reason:, status:, created_at: nil, message_id: nil, node_id: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::JourneyRunStep} for more details.
       #
@@ -51,6 +64,10 @@ module Courier
       #
       #   @param action [String] The kind of node that ran, e.g. `send`, `delay`, or `exit`.
       #
+      #   @param error [Courier::Models::JourneyRunStep::Error, nil] Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+      #
+      #   @param skip_reason [String, nil] Why the step was skipped, e.g. `Node conditions not met`. Set when `status` is `
+      #
       #   @param status [String] The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`. N
       #
       #   @param created_at [String] When the step started, as an ISO 8601 timestamp.
@@ -60,6 +77,24 @@ module Courier
       #   @param node_id [String] The id of the node in the published Journey that this step executed.
       #
       #   @param updated_at [String] When the step last changed state, as an ISO 8601 timestamp.
+
+      # @see Courier::Models::JourneyRunStep#error
+      class Error < Courier::Internal::Type::BaseModel
+        # @!attribute message
+        #   The reason, e.g. `Fetch failed: GET api.example.com returned 404` or
+        #   `AI step timed out after 15 minutes`.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(message:)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::JourneyRunStep::Error} for more details.
+        #
+        #   Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+        #
+        #   @param message [String] The reason, e.g. `Fetch failed: GET api.example.com returned 404` or `AI step ti
+      end
     end
   end
 end

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "6.12.0"
+  VERSION = "6.13.0"
 end

data/rbi/courier/models/journey_run_step.rbi

@@ -12,6 +12,20 @@ module Courier
       sig { returns(String) }
       attr_accessor :action
 
+      # Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+      sig { returns(T.nilable(Courier::JourneyRunStep::Error)) }
+      attr_reader :error
+
+      sig do
+        params(error: T.nilable(Courier::JourneyRunStep::Error::OrHash)).void
+      end
+      attr_writer :error
+
+      # Why the step was skipped, e.g. `Node conditions not met`. Set when `status` is
+      # `SKIPPED`, `null` otherwise.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :skip_reason
+
       # The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`.
       # Not an enum — new values have been added before.
       sig { returns(String) }
@@ -52,6 +66,8 @@ module Courier
       sig do
         params(
           action: String,
+          error: T.nilable(Courier::JourneyRunStep::Error::OrHash),
+          skip_reason: T.nilable(String),
           status: String,
           created_at: String,
           message_id: String,
@@ -62,6 +78,11 @@ module Courier
       def self.new(
         # The kind of node that ran, e.g. `send`, `delay`, or `exit`.
         action:,
+        # Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+        error:,
+        # Why the step was skipped, e.g. `Node conditions not met`. Set when `status` is
+        # `SKIPPED`, `null` otherwise.
+        skip_reason:,
         # The state of the step: the seven run statuses, plus `SKIPPED` and `COMPUTING`.
         # Not an enum — new values have been added before.
         status:,
@@ -82,6 +103,8 @@ module Courier
         override.returns(
           {
             action: String,
+            error: T.nilable(Courier::JourneyRunStep::Error),
+            skip_reason: T.nilable(String),
             status: String,
             created_at: String,
             message_id: String,
@@ -92,6 +115,31 @@ module Courier
       end
       def to_hash
       end
+
+      class Error < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Courier::JourneyRunStep::Error, Courier::Internal::AnyHash)
+          end
+
+        # The reason, e.g. `Fetch failed: GET api.example.com returned 404` or
+        # `AI step timed out after 15 minutes`.
+        sig { returns(String) }
+        attr_accessor :message
+
+        # Why the step failed. Set when `status` is `ERROR`, `null` otherwise.
+        sig { params(message: String).returns(T.attached_class) }
+        def self.new(
+          # The reason, e.g. `Fetch failed: GET api.example.com returned 404` or
+          # `AI step timed out after 15 minutes`.
+          message:
+        )
+        end
+
+        sig { override.returns({ message: String }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/sig/courier/models/journey_run_step.rbs

@@ -3,6 +3,8 @@ module Courier
     type journey_run_step =
       {
         action: String,
+        error: Courier::JourneyRunStep::Error?,
+        skip_reason: String?,
         status: String,
         created_at: String,
         message_id: String,
@@ -13,6 +15,10 @@ module Courier
     class JourneyRunStep < Courier::Internal::Type::BaseModel
       attr_accessor action: String
 
+      attr_accessor error: Courier::JourneyRunStep::Error?
+
+      attr_accessor skip_reason: String?
+
       attr_accessor status: String
 
       attr_reader created_at: String?
@@ -33,6 +39,8 @@ module Courier
 
       def initialize: (
         action: String,
+        error: Courier::JourneyRunStep::Error?,
+        skip_reason: String?,
         status: String,
         ?created_at: String,
         ?message_id: String,
@@ -42,12 +50,24 @@ module Courier
 
       def to_hash: -> {
         action: String,
+        error: Courier::JourneyRunStep::Error?,
+        skip_reason: String?,
         status: String,
         created_at: String,
         message_id: String,
         node_id: String,
         updated_at: String
       }
+
+      type error = { message: String }
+
+      class Error < Courier::Internal::Type::BaseModel
+        attr_accessor message: String
+
+        def initialize: (message: String) -> void
+
+        def to_hash: -> { message: String }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 6.12.0
+  version: 6.13.0
 platform: ruby
 authors:
 - Courier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-21 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool