trycourier 4.10.2 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c653d07cd54be88e8b8328788188c56e6d62e7308f6bccf582769bd38b5e413
-  data.tar.gz: 9a025d1497b0e9383686ba5c849d2784be1195c7c21a52ba24d2491f6e5ebe71
+  metadata.gz: 07ec887deae40e31444ee6401c3b00061e0bbc4156700f5ff1361e1366fab649
+  data.tar.gz: 9167f8538d2652a8cd9e6723ab309f331f7487e1a96f69fa72abea27e4d76c25
 SHA512:
-  metadata.gz: ee312a1f98ddfd71c03692e23047237cd1205465687890e3d0dea3bd675acb6ed1ba30b340e67a85e9cd3d73017c09c29e5ef0a3946c4b6e2ccb806e7af29392
-  data.tar.gz: ac1e5417c4e7400965fc5efc5074e40cff4e5e4b5a4427795884cdba02869dbc54185252d2653c9599fe745b8a78e2fd0793675bf9a08b6a9d5d3903ee0139c8
+  metadata.gz: bdd2bb582d89b2d3c4ebaa5f7d2c70a6cfb72ca9c2288322cb4ce8d21f14deafe67e6546a1d1dd7b007910e5b1fcff183b41336a6ac11fe7eee3706b2104e415
+  data.tar.gz: 98365664a918844655cd990b7195323dc6c60185b5efcaf9a667e12a81d40ec35fc426fbdd98920cfc6f34299101c8b7d6e7e27b1f765698158260ab94c3fa42

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* [C-18380] Journeys API reference: copy + naming cleanup ([5930853](https://github.com/trycourier/courier-ruby/commit/5930853b36e87fc434a5f316d5144459d8a5156c))
+* [SUP-607] Add DELETE endpoint for Courier Create tenant templates ([72df650](https://github.com/trycourier/courier-ruby/commit/72df650b8e3e6bde00a5a8f047c16e77f2c97ac3))
+* **api:** add journey CRUD/templates/versioning endpoints, journey node/condition types ([30bc8f6](https://github.com/trycourier/courier-ruby/commit/30bc8f6ad778a9ca44ed7ccbfa743e23170192b4))
+* support setting headers via env ([6f99d29](https://github.com/trycourier/courier-ruby/commit/6f99d290cad4006de8f84b22cbac6694d314a3aa))
+
+
+### Bug Fixes
+
+* **client:** elide content type header on requests without body ([5f06485](https://github.com/trycourier/courier-ruby/commit/5f0648580bf65a97989fbb1f6583ef7166c43c2f))
+
+
+### Chores
+
+* **internal:** more robust bootstrap script ([91e8fd1](https://github.com/trycourier/courier-ruby/commit/91e8fd1ecdd6d10def9215f53a73248b754b5386))
+
 ## 4.10.2 (2026-04-14)
 
 Full Changelog: [v4.10.1...v4.10.2](https://github.com/trycourier/courier-ruby/compare/v4.10.1...v4.10.2)

data/lib/courier/client.rb

@@ -112,6 +112,19 @@ module Courier
         raise ArgumentError.new("api_key is required, and can be set via environ: \"COURIER_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["COURIER_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
 
       super(
@@ -119,7 +132,8 @@ module Courier
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @send_ = Courier::Resources::Send.new(client: self)

data/lib/courier/internal/transport/base_client.rb

@@ -306,6 +306,8 @@ module Courier
               Courier::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          headers.delete("content-type") if body.nil?
+
           url = Courier::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/courier/models/create_journey_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class CreateJourneyRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!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>]
+      required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
+
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, Courier::Internal::Type::Boolean
+
+      # @!attribute state
+      #   Lifecycle state of a journey.
+      #
+      #   @return [Symbol, Courier::Models::JourneyState, nil]
+      optional :state, enum: -> { Courier::JourneyState }
+
+      # @!method initialize(name:, nodes:, enabled: nil, state: nil)
+      #   Request body for creating a journey.
+      #
+      #   @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 enabled [Boolean]
+      #
+      #   @param state [Symbol, Courier::Models::JourneyState] Lifecycle state of a journey.
+    end
+  end
+end

data/lib/courier/models/journey_ai_node.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyAINode < Courier::Internal::Type::BaseModel
+      # @!attribute output_schema
+      #   A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :output_schema, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyAINode::Type]
+      required :type, enum: -> { Courier::JourneyAINode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, 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 model
+      #
+      #   @return [String, nil]
+      optional :model, String
+
+      # @!attribute user_prompt
+      #
+      #   @return [String, nil]
+      optional :user_prompt, String
+
+      # @!attribute web_search
+      #
+      #   @return [Boolean, nil]
+      optional :web_search, Courier::Internal::Type::Boolean
+
+      # @!method initialize(output_schema:, type:, id: nil, conditions: nil, model: nil, user_prompt: nil, web_search: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyAINode} for more details.
+      #
+      #   Invoke an AI step with `user_prompt` and optional `web_search`. Returns a
+      #   structured response conforming to `output_schema`.
+      #
+      #   @param output_schema [Hash{Symbol=>Object}] A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+      #
+      #   @param type [Symbol, Courier::Models::JourneyAINode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @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 model [String]
+      #
+      #   @param user_prompt [String]
+      #
+      #   @param web_search [Boolean]
+
+      # @see Courier::Models::JourneyAINode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        AI = :ai
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_api_invoke_trigger_node.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyAPIInvokeTriggerNode < Courier::Internal::Type::BaseModel
+      # @!attribute trigger_type
+      #
+      #   @return [Symbol, Courier::Models::JourneyAPIInvokeTriggerNode::TriggerType]
+      required :trigger_type, enum: -> { Courier::JourneyAPIInvokeTriggerNode::TriggerType }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyAPIInvokeTriggerNode::Type]
+      required :type, enum: -> { Courier::JourneyAPIInvokeTriggerNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, 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 schema
+      #   A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :schema, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!method initialize(trigger_type:, type:, id: nil, conditions: nil, schema: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyAPIInvokeTriggerNode} for more details.
+      #
+      #   Trigger fired when the journey is invoked via the API. The optional `schema`
+      #   field is a JSON Schema that validates the invocation payload.
+      #
+      #   @param trigger_type [Symbol, Courier::Models::JourneyAPIInvokeTriggerNode::TriggerType]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyAPIInvokeTriggerNode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @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 schema [Hash{Symbol=>Object}] A JSONSchema object (Draft-07-compatible). Validated at runtime by Ajv.
+
+      # @see Courier::Models::JourneyAPIInvokeTriggerNode#trigger_type
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        API_INVOKE = :"api-invoke"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyAPIInvokeTriggerNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TRIGGER = :trigger
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_archive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#archive
+    class JourneyArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!method initialize(template_id:, request_options: {})
+      #   @param template_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/journey_condition_atom.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @type [Courier::Internal::Type::Converter]
+    JourneyConditionAtom = Courier::Internal::Type::ArrayOf[String]
+  end
+end

data/lib/courier/models/journey_condition_group.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyConditionGroup < Courier::Internal::Type::BaseModel
+      # @!attribute and_
+      #
+      #   @return [Array<Array<String>>, nil]
+      optional :and_,
+               Courier::Internal::Type::ArrayOf[Courier::Internal::Type::ArrayOf[String]],
+               api_name: :AND
+
+      # @!attribute or_
+      #
+      #   @return [Array<Array<String>>, nil]
+      optional :or_, Courier::Internal::Type::ArrayOf[Courier::Internal::Type::ArrayOf[String]], api_name: :OR
+
+      # @!method initialize(and_: nil, or_: nil)
+      #   A leaf condition group. Exactly one of `AND` or `OR` must be present at runtime;
+      #   each is a list of `JourneyConditionAtom` tuples.
+      #
+      #   @param and_ [Array<Array<String>>]
+      #   @param or_ [Array<Array<String>>]
+    end
+  end
+end

data/lib/courier/models/journey_condition_nested_group.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyConditionNestedGroup < Courier::Internal::Type::BaseModel
+      # @!attribute and_
+      #
+      #   @return [Array<Courier::Models::JourneyConditionGroup>, nil]
+      optional :and_, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyConditionGroup] }, api_name: :AND
+
+      # @!attribute or_
+      #
+      #   @return [Array<Courier::Models::JourneyConditionGroup>, nil]
+      optional :or_, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyConditionGroup] }, api_name: :OR
+
+      # @!method initialize(and_: nil, or_: nil)
+      #   A nested condition group. Exactly one of `AND` or `OR` must be present at
+      #   runtime; each is a list of `JourneyConditionGroup` items.
+      #
+      #   @param and_ [Array<Courier::Models::JourneyConditionGroup>]
+      #   @param or_ [Array<Courier::Models::JourneyConditionGroup>]
+    end
+  end
+end

data/lib/courier/models/journey_conditions_field.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # 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".
+    module JourneyConditionsField
+      extend Courier::Internal::Type::Union
+
+      # A single condition expressed as a positional tuple of strings.
+      # - Binary form (3 elements): `[path, operator, value]` where `operator`
+      #   is one of `is equal`, `is not equal`, `contains`, `does not contain`,
+      #   `starts with`, `ends with`, `greater than`, `greater than or equal`,
+      #   `less than`, `less than or equal`.
+      #
+      #   Example: `["user.tier", "is equal", "gold"]`.
+      #
+      # - Unary form (2 elements): `[path, operator]` where `operator` is
+      #   one of `exists`, `does not exist`.
+      #
+      #   Example: `["user.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.
+      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.
+      variant -> { Courier::JourneyConditionGroup }
+
+      # A nested condition group. Exactly one of `AND` or `OR` must be present at runtime; each is a list of `JourneyConditionGroup` items.
+      variant -> { Courier::JourneyConditionNestedGroup }
+
+      # @!method self.variants
+      #   @return [Array(Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup)]
+    end
+  end
+end

data/lib/courier/models/journey_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#create
+    class JourneyCreateParams < Courier::Models::CreateJourneyRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/journey_delay_duration_node.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyDelayDurationNode < Courier::Internal::Type::BaseModel
+      # @!attribute duration
+      #
+      #   @return [String]
+      required :duration, String
+
+      # @!attribute mode
+      #
+      #   @return [Symbol, Courier::Models::JourneyDelayDurationNode::Mode]
+      required :mode, enum: -> { Courier::JourneyDelayDurationNode::Mode }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyDelayDurationNode::Type]
+      required :type, enum: -> { Courier::JourneyDelayDurationNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, 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 }
+
+      # @!method initialize(duration:, mode:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyDelayDurationNode} for more details.
+      #
+      #   Pause the journey run for a fixed `duration`.
+      #
+      #   @param duration [String]
+      #
+      #   @param mode [Symbol, Courier::Models::JourneyDelayDurationNode::Mode]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyDelayDurationNode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @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
+
+      # @see Courier::Models::JourneyDelayDurationNode#mode
+      module Mode
+        extend Courier::Internal::Type::Enum
+
+        DURATION = :duration
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyDelayDurationNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        DELAY = :delay
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_delay_until_node.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyDelayUntilNode < Courier::Internal::Type::BaseModel
+      # @!attribute mode
+      #
+      #   @return [Symbol, Courier::Models::JourneyDelayUntilNode::Mode]
+      required :mode, enum: -> { Courier::JourneyDelayUntilNode::Mode }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyDelayUntilNode::Type]
+      required :type, enum: -> { Courier::JourneyDelayUntilNode::Type }
+
+      # @!attribute until_
+      #
+      #   @return [String]
+      required :until_, String, api_name: :until
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, 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 }
+
+      # @!method initialize(mode:, type:, until_:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyDelayUntilNode} for more details.
+      #
+      #   Pause the journey run `until` a specific time.
+      #
+      #   @param mode [Symbol, Courier::Models::JourneyDelayUntilNode::Mode]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyDelayUntilNode::Type]
+      #
+      #   @param until_ [String]
+      #
+      #   @param id [String]
+      #
+      #   @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
+
+      # @see Courier::Models::JourneyDelayUntilNode#mode
+      module Mode
+        extend Courier::Internal::Type::Enum
+
+        UNTIL = :until
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyDelayUntilNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        DELAY = :delay
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_exit_node.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyExitNode < Courier::Internal::Type::BaseModel
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyExitNode::Type]
+      required :type, enum: -> { Courier::JourneyExitNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!method initialize(type:, id: nil)
+      #   Terminate the journey run.
+      #
+      #   @param type [Symbol, Courier::Models::JourneyExitNode::Type]
+      #   @param id [String]
+
+      # @see Courier::Models::JourneyExitNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        EXIT = :exit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end