trycourier 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ec887deae40e31444ee6401c3b00061e0bbc4156700f5ff1361e1366fab649
-  data.tar.gz: 9167f8538d2652a8cd9e6723ab309f331f7487e1a96f69fa72abea27e4d76c25
+  metadata.gz: e902cf56c5a1bbfd1efeb490133b4cbbd036913b9565d146a4e2a61cf016561e
+  data.tar.gz: d8776360739874f39e33d8ce8a2161910808db4a0dbcc2062c8054ad6a840ee2
 SHA512:
-  metadata.gz: bdd2bb582d89b2d3c4ebaa5f7d2c70a6cfb72ca9c2288322cb4ce8d21f14deafe67e6546a1d1dd7b007910e5b1fcff183b41336a6ac11fe7eee3706b2104e415
-  data.tar.gz: 98365664a918844655cd990b7195323dc6c60185b5efcaf9a667e12a81d40ec35fc426fbdd98920cfc6f34299101c8b7d6e7e27b1f765698158260ab94c3fa42
+  metadata.gz: 9e25bc1935feedf5a3779307ebd3405b64dd491ba0cec9d0df81b68d4f9707fc0b019979a3933e53e68715b419debed4ea7b9c8553312983ee495a95ef82ca5b
+  data.tar.gz: a611de89bb3b2907b6b3997a9b0815c9fd9e4558005046c77ed59eb05ccf21b1898a06856913c606767337b67f1296531e2e66212f6785fb0f002e0d839b13de

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.12.0 (2026-05-28)
+
+Full Changelog: [v4.11.0...v4.12.0](https://github.com/trycourier/courier-ruby/compare/v4.11.0...v4.12.0)
+
+### Features
+
+* C-18612 Add Journeys `batch` node variant to OpenAPI spec ([046a5de](https://github.com/trycourier/courier-ruby/commit/046a5de8a353a40c44f3901313151bf62105c19c))
+* Mark `settings` as required on POST /brands ([72fb020](https://github.com/trycourier/courier-ruby/commit/72fb020cc45f9c4b5384d7492fb8908ac3e82379))
+
 ## 4.11.0 (2026-05-19)
 
 Full Changelog: [v4.10.2...v4.11.0](https://github.com/trycourier/courier-ruby/compare/v4.10.2...v4.11.0)

data/lib/courier/models/brand_create_params.rb

@@ -12,25 +12,25 @@ module Courier
       #   @return [String]
       required :name, String
 
+      # @!attribute settings
+      #
+      #   @return [Courier::Models::BrandSettings]
+      required :settings, -> { Courier::BrandSettings }
+
       # @!attribute id
       #
       #   @return [String, nil]
       optional :id, String, nil?: true
 
-      # @!attribute settings
-      #
-      #   @return [Courier::Models::BrandSettings, nil]
-      optional :settings, -> { Courier::BrandSettings }, nil?: true
-
       # @!attribute snippets
       #
       #   @return [Courier::Models::BrandSnippets, nil]
       optional :snippets, -> { Courier::BrandSnippets }, nil?: true
 
-      # @!method initialize(name:, id: nil, settings: nil, snippets: nil, request_options: {})
+      # @!method initialize(name:, settings:, id: nil, snippets: nil, request_options: {})
       #   @param name [String]
+      #   @param settings [Courier::Models::BrandSettings]
       #   @param id [String, nil]
-      #   @param settings [Courier::Models::BrandSettings, nil]
       #   @param snippets [Courier::Models::BrandSnippets, nil]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/create_journey_request.rb

@@ -10,7 +10,7 @@ module Courier
 
       # @!attribute nodes
       #
-      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
 
       # @!attribute enabled
@@ -29,7 +29,7 @@ module Courier
       #
       #   @param name [String]
       #
-      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       #   @param enabled [Boolean]
       #

data/lib/courier/models/journey_node.rb

@@ -38,12 +38,168 @@ module Courier
       # Throttle the journey by a dynamic `throttle_key`, allowing at most `max_allowed` invocations per `period`.
       variant -> { Courier::JourneyThrottleDynamicNode }
 
+      # Collect events arriving at the node into a single batch and fire one downstream step with the aggregated payload. The first event into a batch owns the run; later contributing events terminate at the batch step. The batch releases when any of `max_items` is reached, a quiet window of `wait_period` elapses, or the `max_wait_period` ceiling hits.
+      variant -> { Courier::JourneyNode::JourneyBatchNode }
+
       # Terminate the journey run.
       variant -> { Courier::JourneyExitNode }
 
       # Branch node. Routes to the first entry in `paths[]` whose `conditions` match, else falls through to `default.nodes`.
       variant -> { Courier::JourneyNode::JourneyBranchNode }
 
+      class JourneyBatchNode < Courier::Internal::Type::BaseModel
+        # @!attribute max_wait_period
+        #   ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+        #   the batch unconditionally when it elapses.
+        #
+        #   @return [String]
+        required :max_wait_period, String
+
+        # @!attribute retain
+        #   How to select which collected events to retain in the aggregated payload when
+        #   the batch releases.
+        #
+        #   @return [Courier::Models::JourneyNode::JourneyBatchNode::Retain]
+        required :retain, -> { Courier::JourneyNode::JourneyBatchNode::Retain }
+
+        # @!attribute scope
+        #
+        #   @return [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Scope]
+        required :scope, enum: -> { Courier::JourneyNode::JourneyBatchNode::Scope }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Type]
+        required :type, enum: -> { Courier::JourneyNode::JourneyBatchNode::Type }
+
+        # @!attribute wait_period
+        #   ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+        #   new contributing events. Must be less than `max_wait_period`.
+        #
+        #   @return [String]
+        required :wait_period, String
+
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute category_key
+        #   Optional partition key. Events with the same `category_key` are batched
+        #   together; events with different values are batched separately.
+        #
+        #   @return [String, nil]
+        optional :category_key, String
+
+        # @!attribute conditions
+        #   Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        #   group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        #   express "no conditions".
+        #
+        #   @return [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil]
+        optional :conditions, union: -> { Courier::JourneyConditionsField }
+
+        # @!attribute max_items
+        #   Releases the batch once this many events have been collected.
+        #
+        #   @return [Integer, nil]
+        optional :max_items, Integer
+
+        # @!method initialize(max_wait_period:, retain:, scope:, type:, wait_period:, id: nil, category_key: nil, conditions: nil, max_items: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::JourneyNode::JourneyBatchNode} for more details.
+        #
+        #   Collect events arriving at the node into a single batch and fire one downstream
+        #   step with the aggregated payload. The first event into a batch owns the run;
+        #   later contributing events terminate at the batch step. The batch releases when
+        #   any of `max_items` is reached, a quiet window of `wait_period` elapses, or the
+        #   `max_wait_period` ceiling hits.
+        #
+        #   @param max_wait_period [String] ISO 8601 duration. Hard ceiling from the first event into the batch; releases th
+        #
+        #   @param retain [Courier::Models::JourneyNode::JourneyBatchNode::Retain] How to select which collected events to retain in the aggregated payload when th
+        #
+        #   @param scope [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Scope]
+        #
+        #   @param type [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Type]
+        #
+        #   @param wait_period [String] ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+        #
+        #   @param id [String]
+        #
+        #   @param category_key [String] Optional partition key. Events with the same `category_key` are batched together
+        #
+        #   @param conditions [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup] Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr
+        #
+        #   @param max_items [Integer] Releases the batch once this many events have been collected.
+
+        # @see Courier::Models::JourneyNode::JourneyBatchNode#retain
+        class Retain < Courier::Internal::Type::BaseModel
+          # @!attribute count
+          #
+          #   @return [Integer]
+          required :count, Integer
+
+          # @!attribute type
+          #
+          #   @return [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Retain::Type]
+          required :type, enum: -> { Courier::JourneyNode::JourneyBatchNode::Retain::Type }
+
+          # @!attribute sort_key
+          #   Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+          #   `highest` or `lowest`.
+          #
+          #   @return [String, nil]
+          optional :sort_key, String
+
+          # @!method initialize(count:, type:, sort_key: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Courier::Models::JourneyNode::JourneyBatchNode::Retain} for more details.
+          #
+          #   How to select which collected events to retain in the aggregated payload when
+          #   the batch releases.
+          #
+          #   @param count [Integer]
+          #
+          #   @param type [Symbol, Courier::Models::JourneyNode::JourneyBatchNode::Retain::Type]
+          #
+          #   @param sort_key [String] Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+
+          # @see Courier::Models::JourneyNode::JourneyBatchNode::Retain#type
+          module Type
+            extend Courier::Internal::Type::Enum
+
+            FIRST = :first
+            LAST = :last
+            HIGHEST = :highest
+            LOWEST = :lowest
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Courier::Models::JourneyNode::JourneyBatchNode#scope
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          USER = :user
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Courier::Models::JourneyNode::JourneyBatchNode#type
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          BATCH = :batch
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       class JourneyBranchNode < Courier::Internal::Type::BaseModel
         # @!attribute default
         #
@@ -133,7 +289,7 @@ module Courier
       end
 
       # @!method self.variants
-      #   @return [Array(Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode)]
+      #   @return [Array(Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode)]
     end
   end
 end

data/lib/courier/models/journey_response.rb

@@ -31,7 +31,7 @@ module Courier
 
       # @!attribute nodes
       #
-      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @return [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
 
       # @!attribute published
@@ -68,7 +68,7 @@ module Courier
       #
       #   @param name [String]
       #
-      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      #   @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       #   @param published [Integer, nil]
       #

data/lib/courier/resources/brands.rb

@@ -3,13 +3,14 @@
 module Courier
   module Resources
     class Brands
-      # Create a new brand
+      # Create a new brand. Requires `name` and `settings` (with at least
+      # `colors.primary` and `colors.secondary`).
       #
-      # @overload create(name:, id: nil, settings: nil, snippets: nil, request_options: {})
+      # @overload create(name:, settings:, id: nil, snippets: nil, request_options: {})
       #
       # @param name [String]
+      # @param settings [Courier::Models::BrandSettings]
       # @param id [String, nil]
-      # @param settings [Courier::Models::BrandSettings, nil]
       # @param snippets [Courier::Models::BrandSnippets, nil]
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/courier/resources/journeys.rb

@@ -17,7 +17,7 @@ module Courier
       #
       # @param name [String]
       #
-      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       # @param enabled [Boolean]
       #
@@ -204,7 +204,7 @@ module Courier
       #
       # @param name [String]
       #
-      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       # @param enabled [Boolean]
       #

data/lib/courier/version.rb

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

data/rbi/courier/models/brand_create_params.rbi

@@ -14,15 +14,15 @@ module Courier
       sig { returns(String) }
       attr_accessor :name
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :id
-
-      sig { returns(T.nilable(Courier::BrandSettings)) }
+      sig { returns(Courier::BrandSettings) }
       attr_reader :settings
 
-      sig { params(settings: T.nilable(Courier::BrandSettings::OrHash)).void }
+      sig { params(settings: Courier::BrandSettings::OrHash).void }
       attr_writer :settings
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+
       sig { returns(T.nilable(Courier::BrandSnippets)) }
       attr_reader :snippets
 
@@ -32,16 +32,16 @@ module Courier
       sig do
         params(
           name: String,
+          settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
-          settings: T.nilable(Courier::BrandSettings::OrHash),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         name:,
+        settings:,
         id: nil,
-        settings: nil,
         snippets: nil,
         request_options: {}
       )
@@ -51,8 +51,8 @@ module Courier
         override.returns(
           {
             name: String,
+            settings: Courier::BrandSettings,
             id: T.nilable(String),
-            settings: T.nilable(Courier::BrandSettings),
             snippets: T.nilable(Courier::BrandSnippets),
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/create_journey_request.rbi

@@ -25,6 +25,7 @@ module Courier
               Courier::JourneyAINode,
               Courier::JourneyThrottleStaticNode,
               Courier::JourneyThrottleDynamicNode,
+              Courier::JourneyNode::JourneyBatchNode,
               Courier::JourneyExitNode,
               Courier::JourneyNode::JourneyBranchNode
             )
@@ -63,6 +64,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )
@@ -97,6 +99,7 @@ module Courier
                   Courier::JourneyAINode,
                   Courier::JourneyThrottleStaticNode,
                   Courier::JourneyThrottleDynamicNode,
+                  Courier::JourneyNode::JourneyBatchNode,
                   Courier::JourneyExitNode,
                   Courier::JourneyNode::JourneyBranchNode
                 )

data/rbi/courier/models/journey_node.rbi

@@ -21,11 +21,326 @@ module Courier
             Courier::JourneyAINode,
             Courier::JourneyThrottleStaticNode,
             Courier::JourneyThrottleDynamicNode,
+            Courier::JourneyNode::JourneyBatchNode,
             Courier::JourneyExitNode,
             Courier::JourneyNode::JourneyBranchNode
           )
         end
 
+      class JourneyBatchNode < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::JourneyNode::JourneyBatchNode,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+        # the batch unconditionally when it elapses.
+        sig { returns(String) }
+        attr_accessor :max_wait_period
+
+        # How to select which collected events to retain in the aggregated payload when
+        # the batch releases.
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Retain) }
+        attr_reader :retain
+
+        sig do
+          params(
+            retain: Courier::JourneyNode::JourneyBatchNode::Retain::OrHash
+          ).void
+        end
+        attr_writer :retain
+
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol) }
+        attr_accessor :scope
+
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol) }
+        attr_accessor :type
+
+        # ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+        # new contributing events. Must be less than `max_wait_period`.
+        sig { returns(String) }
+        attr_accessor :wait_period
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Optional partition key. Events with the same `category_key` are batched
+        # together; events with different values are batched separately.
+        sig { returns(T.nilable(String)) }
+        attr_reader :category_key
+
+        sig { params(category_key: String).void }
+        attr_writer :category_key
+
+        # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        # express "no conditions".
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              )
+            )
+          )
+        end
+        attr_reader :conditions
+
+        sig do
+          params(
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup::OrHash,
+                Courier::JourneyConditionNestedGroup::OrHash
+              )
+          ).void
+        end
+        attr_writer :conditions
+
+        # Releases the batch once this many events have been collected.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_items
+
+        sig { params(max_items: Integer).void }
+        attr_writer :max_items
+
+        # Collect events arriving at the node into a single batch and fire one downstream
+        # step with the aggregated payload. The first event into a batch owns the run;
+        # later contributing events terminate at the batch step. The batch releases when
+        # any of `max_items` is reached, a quiet window of `wait_period` elapses, or the
+        # `max_wait_period` ceiling hits.
+        sig do
+          params(
+            max_wait_period: String,
+            retain: Courier::JourneyNode::JourneyBatchNode::Retain::OrHash,
+            scope: Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol,
+            type: Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol,
+            wait_period: String,
+            id: String,
+            category_key: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup::OrHash,
+                Courier::JourneyConditionNestedGroup::OrHash
+              ),
+            max_items: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+          # the batch unconditionally when it elapses.
+          max_wait_period:,
+          # How to select which collected events to retain in the aggregated payload when
+          # the batch releases.
+          retain:,
+          scope:,
+          type:,
+          # ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+          # new contributing events. Must be less than `max_wait_period`.
+          wait_period:,
+          id: nil,
+          # Optional partition key. Events with the same `category_key` are batched
+          # together; events with different values are batched separately.
+          category_key: nil,
+          # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+          # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+          # express "no conditions".
+          conditions: nil,
+          # Releases the batch once this many events have been collected.
+          max_items: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              max_wait_period: String,
+              retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+              scope: Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol,
+              type: Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol,
+              wait_period: String,
+              id: String,
+              category_key: String,
+              conditions:
+                T.any(
+                  T::Array[String],
+                  Courier::JourneyConditionGroup,
+                  Courier::JourneyConditionNestedGroup
+                ),
+              max_items: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Retain < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyNode::JourneyBatchNode::Retain,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Integer) }
+          attr_accessor :count
+
+          sig do
+            returns(
+              Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol
+            )
+          end
+          attr_accessor :type
+
+          # Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+          # `highest` or `lowest`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sort_key
+
+          sig { params(sort_key: String).void }
+          attr_writer :sort_key
+
+          # How to select which collected events to retain in the aggregated payload when
+          # the batch releases.
+          sig do
+            params(
+              count: Integer,
+              type:
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol,
+              sort_key: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            count:,
+            type:,
+            # Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+            # `highest` or `lowest`.
+            sort_key: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                count: Integer,
+                type:
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol,
+                sort_key: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Type
+            extend Courier::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIRST =
+              T.let(
+                :first,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            LAST =
+              T.let(
+                :last,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            HIGHEST =
+              T.let(
+                :highest,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            LOWEST =
+              T.let(
+                :lowest,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::JourneyNode::JourneyBatchNode::Scope)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          USER =
+            T.let(
+              :user,
+              Courier::JourneyNode::JourneyBatchNode::Scope::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::JourneyNode::JourneyBatchNode::Scope::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::JourneyNode::JourneyBatchNode::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BATCH =
+            T.let(
+              :batch,
+              Courier::JourneyNode::JourneyBatchNode::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::JourneyNode::JourneyBatchNode::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class JourneyBranchNode < Courier::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/courier/models/journey_response.rbi

@@ -60,6 +60,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )

data/rbi/courier/resources/brands.rbi

@@ -3,23 +3,18 @@
 module Courier
   module Resources
     class Brands
-      # Create a new brand
+      # Create a new brand. Requires `name` and `settings` (with at least
+      # `colors.primary` and `colors.secondary`).
       sig do
         params(
           name: String,
+          settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
-          settings: T.nilable(Courier::BrandSettings::OrHash),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Brand)
       end
-      def create(
-        name:,
-        id: nil,
-        settings: nil,
-        snippets: nil,
-        request_options: {}
-      )
+      def create(name:, settings:, id: nil, snippets: nil, request_options: {})
       end
 
       # Fetch a specific brand by brand ID.

data/rbi/courier/resources/journeys.rbi

@@ -28,6 +28,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )
@@ -187,6 +188,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )

data/sig/courier/models/brand_create_params.rbs

@@ -3,8 +3,8 @@ module Courier
     type brand_create_params =
       {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?
       }
       & Courier::Internal::Type::request_parameters
@@ -15,24 +15,24 @@ module Courier
 
       attr_accessor name: String
 
-      attr_accessor id: String?
+      attr_accessor settings: Courier::BrandSettings
 
-      attr_accessor settings: Courier::BrandSettings?
+      attr_accessor id: String?
 
       attr_accessor snippets: Courier::BrandSnippets?
 
       def initialize: (
         name: String,
+        settings: Courier::BrandSettings,
         ?id: String?,
-        ?settings: Courier::BrandSettings?,
         ?snippets: Courier::BrandSnippets?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/journey_node.rbs

@@ -11,12 +11,142 @@ module Courier
       | Courier::JourneyAINode
       | Courier::JourneyThrottleStaticNode
       | Courier::JourneyThrottleDynamicNode
+      | Courier::JourneyNode::JourneyBatchNode
       | Courier::JourneyExitNode
       | Courier::JourneyNode::JourneyBranchNode
 
     module JourneyNode
       extend Courier::Internal::Type::Union
 
+      type journey_batch_node =
+        {
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          id: String,
+          category_key: String,
+          conditions: Courier::Models::journey_conditions_field,
+          max_items: Integer
+        }
+
+      class JourneyBatchNode < Courier::Internal::Type::BaseModel
+        attr_accessor max_wait_period: String
+
+        attr_accessor retain: Courier::JourneyNode::JourneyBatchNode::Retain
+
+        attr_accessor scope: Courier::Models::JourneyNode::JourneyBatchNode::scope
+
+        attr_accessor type: Courier::Models::JourneyNode::JourneyBatchNode::type_
+
+        attr_accessor wait_period: String
+
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader category_key: String?
+
+        def category_key=: (String) -> String
+
+        attr_reader conditions: Courier::Models::journey_conditions_field?
+
+        def conditions=: (
+          Courier::Models::journey_conditions_field
+        ) -> Courier::Models::journey_conditions_field
+
+        attr_reader max_items: Integer?
+
+        def max_items=: (Integer) -> Integer
+
+        def initialize: (
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          ?id: String,
+          ?category_key: String,
+          ?conditions: Courier::Models::journey_conditions_field,
+          ?max_items: Integer
+        ) -> void
+
+        def to_hash: -> {
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          id: String,
+          category_key: String,
+          conditions: Courier::Models::journey_conditions_field,
+          max_items: Integer
+        }
+
+        type retain =
+          {
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            sort_key: String
+          }
+
+        class Retain < Courier::Internal::Type::BaseModel
+          attr_accessor count: Integer
+
+          attr_accessor type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_
+
+          attr_reader sort_key: String?
+
+          def sort_key=: (String) -> String
+
+          def initialize: (
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            ?sort_key: String
+          ) -> void
+
+          def to_hash: -> {
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            sort_key: String
+          }
+
+          type type_ = :first | :last | :highest | :lowest
+
+          module Type
+            extend Courier::Internal::Type::Enum
+
+            FIRST: :first
+            LAST: :last
+            HIGHEST: :highest
+            LOWEST: :lowest
+
+            def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_]
+          end
+        end
+
+        type scope = :user
+
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          USER: :user
+
+          def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::scope]
+        end
+
+        type type_ = :batch
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          BATCH: :batch
+
+          def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::type_]
+        end
+      end
+
       type journey_branch_node =
         {
           default: Courier::JourneyNode::JourneyBranchNode::Default,

data/sig/courier/resources/brands.rbs

@@ -3,8 +3,8 @@ module Courier
     class Brands
       def create: (
         name: String,
+        settings: Courier::BrandSettings,
         ?id: String?,
-        ?settings: Courier::BrandSettings?,
         ?snippets: Courier::BrandSnippets?,
         ?request_options: Courier::request_opts
       ) -> Courier::Brand

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Courier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi