trycourier 4.17.1 → 4.18.1

data/rbi/courier/models/audience_update_params.rbi

@@ -31,7 +31,9 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
-      # The logical operator (AND/OR) for the top-level filter
+      # The logical operator (AND/OR) combining the top-level `filter.filters`.
+      # Convenience alias for `filter.operator`: if set, it is applied to the top-level
+      # filter group. Prefer setting `operator` directly inside `filter`.
       sig do
         returns(T.nilable(Courier::AudienceUpdateParams::Operator::OrSymbol))
       end
@@ -56,7 +58,9 @@ module Courier
         filter: nil,
         # The name of the audience
         name: nil,
-        # The logical operator (AND/OR) for the top-level filter
+        # The logical operator (AND/OR) combining the top-level `filter.filters`.
+        # Convenience alias for `filter.operator`: if set, it is applied to the top-level
+        # filter group. Prefer setting `operator` directly inside `filter`.
         operator: nil,
         request_options: {}
       )
@@ -78,7 +82,9 @@ module Courier
       def to_hash
       end
 
-      # The logical operator (AND/OR) for the top-level filter
+      # The logical operator (AND/OR) combining the top-level `filter.filters`.
+      # Convenience alias for `filter.operator`: if set, it is applied to the top-level
+      # filter group. Prefer setting `operator` directly inside `filter`.
       module Operator
         extend Courier::Internal::Type::Enum
 

data/rbi/courier/models/cancel_journey_request.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Request body for `POST /journeys/cancel`. Provide EXACTLY ONE of
+    # `cancelation_token` (cancels every run associated with the token) or `run_id`
+    # (cancels a single tenant-scoped run).
+    module CancelJourneyRequest
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::CancelJourneyRequest::ByCancelationToken,
+            Courier::CancelJourneyRequest::ByRunID
+          )
+        end
+
+      class ByCancelationToken < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyRequest::ByCancelationToken,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :cancelation_token
+
+        sig { params(cancelation_token: String).returns(T.attached_class) }
+        def self.new(cancelation_token:)
+        end
+
+        sig { override.returns({ cancelation_token: String }) }
+        def to_hash
+        end
+      end
+
+      class ByRunID < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyRequest::ByRunID,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        sig { params(run_id: String).returns(T.attached_class) }
+        def self.new(run_id:)
+        end
+
+        sig { override.returns({ run_id: String }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Courier::CancelJourneyRequest::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/cancel_journey_response.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Courier
+  module Models
+    # `202 Accepted` body for `POST /journeys/cancel`, returning the submitted
+    # identifier. When called with `cancelation_token`, returns
+    # `{ cancelation_token }`; when called with `run_id`, returns
+    # `{ run_id, status }`.
+    module CancelJourneyResponse
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::CancelJourneyResponse::TokenBranch,
+            Courier::CancelJourneyResponse::RunIDBranch
+          )
+        end
+
+      class TokenBranch < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyResponse::TokenBranch,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :cancelation_token
+
+        sig { params(cancelation_token: String).returns(T.attached_class) }
+        def self.new(cancelation_token:)
+        end
+
+        sig { override.returns({ cancelation_token: String }) }
+        def to_hash
+        end
+      end
+
+      class RunIDBranch < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::CancelJourneyResponse::RunIDBranch,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :run_id
+
+        # The run's resulting status. `CANCELED` when the run was active and has been
+        # canceled; `PROCESSED` or `ERROR` when the run had already finished and was left
+        # unchanged; `CANCELED` for an already-canceled run.
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { params(run_id: String, status: String).returns(T.attached_class) }
+        def self.new(
+          run_id:,
+          # The run's resulting status. `CANCELED` when the run was active and has been
+          # canceled; `PROCESSED` or `ERROR` when the run had already finished and was left
+          # unchanged; `CANCELED` for an already-canceled run.
+          status:
+        )
+        end
+
+        sig { override.returns({ run_id: String, status: String }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Courier::CancelJourneyResponse::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_cancel_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyCancelParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyCancelParams, Courier::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_experiment.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyExperiment < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyExperiment, Courier::Internal::AnyHash)
+        end
+
+      # The value used to deterministically assign a recipient to a variant. Must be
+      # non-empty with no leading or trailing whitespace.
+      sig { returns(String) }
+      attr_accessor :bucketing_key
+
+      # Between 2 and 10 weighted template variants.
+      sig { returns(T::Array[Courier::JourneyExperimentVariant]) }
+      attr_accessor :variants
+
+      # Unique experiment id (prefixed `exp_`). Omit to have one generated
+      # automatically; when supplied it must be a valid `exp_` id.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Optional display name for the experiment.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # A/B experiment config for a send node. The recipient is deterministically
+      # bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+      # its `weight`. Present on a send node INSTEAD OF `message.template`.
+      sig do
+        params(
+          bucketing_key: String,
+          variants: T::Array[Courier::JourneyExperimentVariant::OrHash],
+          id: String,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The value used to deterministically assign a recipient to a variant. Must be
+        # non-empty with no leading or trailing whitespace.
+        bucketing_key:,
+        # Between 2 and 10 weighted template variants.
+        variants:,
+        # Unique experiment id (prefixed `exp_`). Omit to have one generated
+        # automatically; when supplied it must be a valid `exp_` id.
+        id: nil,
+        # Optional display name for the experiment.
+        name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            bucketing_key: String,
+            variants: T::Array[Courier::JourneyExperimentVariant],
+            id: String,
+            name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_experiment_variant.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyExperimentVariant < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyExperimentVariant, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The notification template sent for this variant.
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # Relative routing weight. Must be non-negative.
+      sig { returns(Float) }
+      attr_accessor :weight
+
+      # Optional display name for the variant.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # A single weighted variant of an experiment. Variant ids must be unique within
+      # the experiment and the sum of all variant weights must be greater than 0.
+      # Weights are relative (no sum-to-100 requirement) — routing normalizes them
+      # proportionally.
+      sig do
+        params(
+          id: String,
+          template_id: String,
+          weight: Float,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # The notification template sent for this variant.
+        template_id:,
+        # Relative routing weight. Must be non-negative.
+        weight:,
+        # Optional display name for the variant.
+        name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, template_id: String, weight: Float, name: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_send_node.rbi

@@ -51,8 +51,20 @@ module Courier
       end
       attr_writer :conditions
 
-      # Send a notification template to the recipient. Optionally override the recipient
-      # address, delay the send, or attach `data`.
+      # A/B experiment config for a send node. The recipient is deterministically
+      # bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+      # its `weight`. Present on a send node INSTEAD OF `message.template`.
+      sig { returns(T.nilable(Courier::JourneyExperiment)) }
+      attr_reader :experiment
+
+      sig { params(experiment: Courier::JourneyExperiment::OrHash).void }
+      attr_writer :experiment
+
+      # Send to the recipient. A send node sources its content from EXACTLY ONE of
+      # `message.template` (a single notification template) or `experiment` (an A/B
+      # split across weighted template variants) — supplying both, or neither, is
+      # rejected. Optionally override the recipient address, delay the send, or attach
+      # `data`.
       sig do
         params(
           message: Courier::JourneySendNode::Message::OrHash,
@@ -63,7 +75,8 @@ module Courier
               T::Array[String],
               Courier::JourneyConditionGroup::OrHash,
               Courier::JourneyConditionNestedGroup::OrHash
-            )
+            ),
+          experiment: Courier::JourneyExperiment::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -73,7 +86,11 @@ module Courier
         # 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
+        conditions: nil,
+        # A/B experiment config for a send node. The recipient is deterministically
+        # bucketed by `bucketingKey` and routed to one of the `variants` in proportion to
+        # its `weight`. Present on a send node INSTEAD OF `message.template`.
+        experiment: nil
       )
       end
 
@@ -88,7 +105,8 @@ module Courier
                 T::Array[String],
                 Courier::JourneyConditionGroup,
                 Courier::JourneyConditionNestedGroup
-              )
+              ),
+            experiment: Courier::JourneyExperiment
           }
         )
       end
@@ -101,9 +119,6 @@ module Courier
             T.any(Courier::JourneySendNode::Message, Courier::Internal::AnyHash)
           end
 
-        sig { returns(String) }
-        attr_accessor :template
-
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :data
 
@@ -118,6 +133,12 @@ module Courier
         end
         attr_writer :delay
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :template
+
+        sig { params(template: String).void }
+        attr_writer :template
+
         sig { returns(T.nilable(Courier::JourneySendNode::Message::To)) }
         attr_reader :to
 
@@ -126,21 +147,21 @@ module Courier
 
         sig do
           params(
-            template: String,
             data: T::Hash[Symbol, T.anything],
             delay: Courier::JourneySendNode::Message::Delay::OrHash,
+            template: String,
             to: Courier::JourneySendNode::Message::To::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(template:, data: nil, delay: nil, to: nil)
+        def self.new(data: nil, delay: nil, template: nil, to: nil)
         end
 
         sig do
           override.returns(
             {
-              template: String,
               data: T::Hash[Symbol, T.anything],
               delay: Courier::JourneySendNode::Message::Delay,
+              template: String,
               to: Courier::JourneySendNode::Message::To
             }
           )

data/rbi/courier/models.rbi

@@ -87,6 +87,10 @@ module Courier
 
   BulkRunJobParams = Courier::Models::BulkRunJobParams
 
+  CancelJourneyRequest = Courier::Models::CancelJourneyRequest
+
+  CancelJourneyResponse = Courier::Models::CancelJourneyResponse
+
   Channel = Courier::Models::Channel
 
   ChannelClassification = Courier::Models::ChannelClassification
@@ -171,6 +175,8 @@ module Courier
 
   JourneyArchiveParams = Courier::Models::JourneyArchiveParams
 
+  JourneyCancelParams = Courier::Models::JourneyCancelParams
+
   JourneyConditionAtom =
     T.let(
       Courier::Models::JourneyConditionAtom,
@@ -191,6 +197,10 @@ module Courier
 
   JourneyExitNode = Courier::Models::JourneyExitNode
 
+  JourneyExperiment = Courier::Models::JourneyExperiment
+
+  JourneyExperimentVariant = Courier::Models::JourneyExperimentVariant
+
   JourneyFetchGetDeleteNode = Courier::Models::JourneyFetchGetDeleteNode
 
   JourneyFetchPostPutNode = Courier::Models::JourneyFetchPostPutNode

data/rbi/courier/resources/audiences.rbi

@@ -38,7 +38,9 @@ module Courier
         filter: nil,
         # The name of the audience
         name: nil,
-        # The logical operator (AND/OR) for the top-level filter
+        # The logical operator (AND/OR) combining the top-level `filter.filters`.
+        # Convenience alias for `filter.operator`: if set, it is applied to the top-level
+        # filter group. Prefer setting `operator` directly inside `filter`.
         operator: nil,
         request_options: {}
       )

data/rbi/courier/resources/journeys.rbi

@@ -101,6 +101,31 @@ module Courier
       )
       end
 
+      # Cancel journey runs. The request body must include EXACTLY ONE of
+      # `cancelation_token` (cancels every run associated with the token) or `run_id`
+      # (cancels a single tenant-scoped run). Supplying both or neither returns a `400`.
+      # A `run_id` that does not match a run for the tenant returns `404`. Cancelation
+      # is idempotent: a run that has already finished (`PROCESSED`/`ERROR`) or was
+      # already `CANCELED` is left unchanged and its current status is returned.
+      sig do
+        params(
+          cancel_journey_request:
+            T.any(
+              Courier::CancelJourneyRequest::ByCancelationToken::OrHash,
+              Courier::CancelJourneyRequest::ByRunID::OrHash
+            ),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::CancelJourneyResponse::Variants)
+      end
+      def cancel(
+        # Request body for `POST /journeys/cancel`. Provide EXACTLY ONE of
+        # `cancelation_token` (cancels every run associated with the token) or `run_id`
+        # (cancels a single tenant-scoped run).
+        cancel_journey_request:,
+        request_options: {}
+      )
+      end
+
       # Invoke a journey by id or alias to start a new run. The response includes a
       # `runId` identifying the run.
       sig do

data/sig/courier/models/audience_filter_config.rbs

@@ -1,13 +1,40 @@
 module Courier
   module Models
-    type audience_filter_config = { filters: ::Array[Courier::FilterConfig] }
+    type audience_filter_config =
+      {
+        filters: ::Array[Courier::FilterConfig],
+        operator: Courier::Models::AudienceFilterConfig::operator
+      }
 
     class AudienceFilterConfig < Courier::Internal::Type::BaseModel
       attr_accessor filters: ::Array[Courier::FilterConfig]
 
-      def initialize: (filters: ::Array[Courier::FilterConfig]) -> void
+      attr_reader operator: Courier::Models::AudienceFilterConfig::operator?
 
-      def to_hash: -> { filters: ::Array[Courier::FilterConfig] }
+      def operator=: (
+        Courier::Models::AudienceFilterConfig::operator
+      ) -> Courier::Models::AudienceFilterConfig::operator
+
+      def initialize: (
+        filters: ::Array[Courier::FilterConfig],
+        ?operator: Courier::Models::AudienceFilterConfig::operator
+      ) -> void
+
+      def to_hash: -> {
+        filters: ::Array[Courier::FilterConfig],
+        operator: Courier::Models::AudienceFilterConfig::operator
+      }
+
+      type operator = :AND | :OR
+
+      module Operator
+        extend Courier::Internal::Type::Enum
+
+        AND: :AND
+        OR: :OR
+
+        def self?.values: -> ::Array[Courier::Models::AudienceFilterConfig::operator]
+      end
     end
   end
 end

data/sig/courier/models/cancel_journey_request.rbs

@@ -0,0 +1,33 @@
+module Courier
+  module Models
+    type cancel_journey_request =
+      Courier::CancelJourneyRequest::ByCancelationToken
+      | Courier::CancelJourneyRequest::ByRunID
+
+    module CancelJourneyRequest
+      extend Courier::Internal::Type::Union
+
+      type by_cancelation_token = { cancelation_token: String }
+
+      class ByCancelationToken < Courier::Internal::Type::BaseModel
+        attr_accessor cancelation_token: String
+
+        def initialize: (cancelation_token: String) -> void
+
+        def to_hash: -> { cancelation_token: String }
+      end
+
+      type by_run_id = { run_id: String }
+
+      class ByRunID < Courier::Internal::Type::BaseModel
+        attr_accessor run_id: String
+
+        def initialize: (run_id: String) -> void
+
+        def to_hash: -> { run_id: String }
+      end
+
+      def self?.variants: -> ::Array[Courier::Models::cancel_journey_request]
+    end
+  end
+end

data/sig/courier/models/cancel_journey_response.rbs

@@ -0,0 +1,35 @@
+module Courier
+  module Models
+    type cancel_journey_response =
+      Courier::CancelJourneyResponse::TokenBranch
+      | Courier::CancelJourneyResponse::RunIDBranch
+
+    module CancelJourneyResponse
+      extend Courier::Internal::Type::Union
+
+      type token_branch = { cancelation_token: String }
+
+      class TokenBranch < Courier::Internal::Type::BaseModel
+        attr_accessor cancelation_token: String
+
+        def initialize: (cancelation_token: String) -> void
+
+        def to_hash: -> { cancelation_token: String }
+      end
+
+      type run_id_branch = { run_id: String, status: String }
+
+      class RunIDBranch < Courier::Internal::Type::BaseModel
+        attr_accessor run_id: String
+
+        attr_accessor status: String
+
+        def initialize: (run_id: String, status: String) -> void
+
+        def to_hash: -> { run_id: String, status: String }
+      end
+
+      def self?.variants: -> ::Array[Courier::Models::cancel_journey_response]
+    end
+  end
+end

data/sig/courier/models/journey_cancel_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type journey_cancel_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class JourneyCancelParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end