trycourier 4.17.0 → 4.18.0

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/{preference_section_retrieve_params.rbi → workspace_preference_archive_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionRetrieveParams,
+            Courier::WorkspacePreferenceArchiveParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_section_create_params.rbi → workspace_preference_create_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionCreateParams,
+            Courier::WorkspacePreferenceCreateParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_section_create_request.rbi → workspace_preference_create_request.rbi}

@@ -2,30 +2,30 @@
 
 module Courier
   module Models
-    class PreferenceSectionCreateRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionCreateRequest,
+            Courier::WorkspacePreferenceCreateRequest,
             Courier::Internal::AnyHash
           )
         end
 
-      # Human-readable name for the section.
+      # Human-readable name for the workspace preference.
       sig { returns(String) }
       attr_accessor :name
 
-      # Whether the section defines custom routing for its topics.
+      # Whether the workspace preference defines custom routing for its topics.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :has_custom_routing
 
-      # Default channels for the section. Defaults to empty if omitted.
+      # Default channels for the workspace preference. Defaults to empty if omitted.
       sig do
         returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
       end
       attr_accessor :routing_options
 
-      # Request body for creating a preference section.
+      # Request body for creating a workspace preference.
       sig do
         params(
           name: String,
@@ -35,11 +35,11 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Defaults to empty if omitted.
+        # Default channels for the workspace preference. Defaults to empty if omitted.
         routing_options: nil
       )
       end

data/rbi/courier/models/{preference_section_get_response.rbi → workspace_preference_get_response.rbi}

@@ -2,24 +2,24 @@
 
 module Courier
   module Models
-    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionGetResponse,
+            Courier::WorkspacePreferenceGetResponse,
             Courier::Internal::AnyHash
           )
         end
 
-      # The preference section id.
+      # The workspace preference id.
       sig { returns(String) }
       attr_accessor :id
 
-      # ISO-8601 timestamp of when the section was created.
+      # ISO-8601 timestamp of when the workspace preference was created.
       sig { returns(String) }
       attr_accessor :created
 
-      # Whether the section defines custom routing for its topics.
+      # Whether the workspace preference defines custom routing for its topics.
       sig { returns(T::Boolean) }
       attr_accessor :has_custom_routing
 
@@ -27,12 +27,12 @@ module Courier
       sig { returns(String) }
       attr_accessor :name
 
-      # Default channels for the section. May be empty.
+      # Default channels for the workspace preference. May be empty.
       sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
       attr_accessor :routing_options
 
-      # The topics contained in this section.
-      sig { returns(T::Array[Courier::PreferenceTopicGetResponse]) }
+      # The topics contained in this workspace preference.
+      sig { returns(T::Array[Courier::WorkspacePreferenceTopicGetResponse]) }
       attr_accessor :topics
 
       # Id of the creator.
@@ -47,7 +47,7 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :updater
 
-      # A preference section in your workspace, including its topics.
+      # A workspace preference in your workspace, including its topics.
       sig do
         params(
           id: String,
@@ -55,24 +55,25 @@ module Courier
           has_custom_routing: T::Boolean,
           name: String,
           routing_options: T::Array[Courier::ChannelClassification::OrSymbol],
-          topics: T::Array[Courier::PreferenceTopicGetResponse::OrHash],
+          topics:
+            T::Array[Courier::WorkspacePreferenceTopicGetResponse::OrHash],
           creator: T.nilable(String),
           updated: T.nilable(String),
           updater: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
-        # The preference section id.
+        # The workspace preference id.
         id:,
-        # ISO-8601 timestamp of when the section was created.
+        # ISO-8601 timestamp of when the workspace preference was created.
         created:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing:,
         # Human-readable name.
         name:,
-        # Default channels for the section. May be empty.
+        # Default channels for the workspace preference. May be empty.
         routing_options:,
-        # The topics contained in this section.
+        # The topics contained in this workspace preference.
         topics:,
         # Id of the creator.
         creator: nil,
@@ -92,7 +93,7 @@ module Courier
             name: String,
             routing_options:
               T::Array[Courier::ChannelClassification::TaggedSymbol],
-            topics: T::Array[Courier::PreferenceTopicGetResponse],
+            topics: T::Array[Courier::WorkspacePreferenceTopicGetResponse],
             creator: T.nilable(String),
             updated: T.nilable(String),
             updater: T.nilable(String)

data/rbi/courier/models/{preference_section_list_params.rbi → workspace_preference_list_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionListParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceListParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionListParams,
+            Courier::WorkspacePreferenceListParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_topic_list_response.rbi → workspace_preference_list_response.rbi}

@@ -2,22 +2,22 @@
 
 module Courier
   module Models
-    class PreferenceTopicListResponse < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceListResponse < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceTopicListResponse,
+            Courier::WorkspacePreferenceListResponse,
             Courier::Internal::AnyHash
           )
         end
 
-      sig { returns(T::Array[Courier::PreferenceTopicGetResponse]) }
+      sig { returns(T::Array[Courier::WorkspacePreferenceGetResponse]) }
       attr_accessor :results
 
-      # Topics contained in a preference section.
+      # The workspace's preferences, each with its topics.
       sig do
         params(
-          results: T::Array[Courier::PreferenceTopicGetResponse::OrHash]
+          results: T::Array[Courier::WorkspacePreferenceGetResponse::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(results:)
@@ -25,7 +25,7 @@ module Courier
 
       sig do
         override.returns(
-          { results: T::Array[Courier::PreferenceTopicGetResponse] }
+          { results: T::Array[Courier::WorkspacePreferenceGetResponse] }
         )
       end
       def to_hash

data/rbi/courier/models/{preference_section_publish_params.rbi → workspace_preference_publish_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionPublishParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionPublishParams,
+            Courier::WorkspacePreferencePublishParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_section_replace_params.rbi → workspace_preference_replace_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionReplaceParams < Courier::Models::PreferenceSectionReplaceRequest
+    class WorkspacePreferenceReplaceParams < Courier::Models::WorkspacePreferenceReplaceRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionReplaceParams,
+            Courier::WorkspacePreferenceReplaceParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_section_replace_request.rbi → workspace_preference_replace_request.rbi}

@@ -2,30 +2,30 @@
 
 module Courier
   module Models
-    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceReplaceRequest < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionReplaceRequest,
+            Courier::WorkspacePreferenceReplaceRequest,
             Courier::Internal::AnyHash
           )
         end
 
-      # Human-readable name for the section.
+      # Human-readable name for the workspace preference.
       sig { returns(String) }
       attr_accessor :name
 
-      # Whether the section defines custom routing for its topics.
+      # Whether the workspace preference defines custom routing for its topics.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :has_custom_routing
 
-      # Default channels for the section. Omit to clear.
+      # Default channels for the workspace preference. Omit to clear.
       sig do
         returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
       end
       attr_accessor :routing_options
 
-      # Request body for replacing a preference section. Full document replacement;
+      # Request body for replacing a workspace preference. Full document replacement;
       # missing optional fields are cleared.
       sig do
         params(
@@ -36,11 +36,11 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Omit to clear.
+        # Default channels for the workspace preference. Omit to clear.
         routing_options: nil
       )
       end

data/rbi/courier/models/{preference_section_archive_params.rbi → workspace_preference_retrieve_params.rbi}

@@ -2,14 +2,14 @@
 
 module Courier
   module Models
-    class PreferenceSectionArchiveParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceSectionArchiveParams,
+            Courier::WorkspacePreferenceRetrieveParams,
             Courier::Internal::AnyHash
           )
         end

data/rbi/courier/models/{preference_topic_create_request.rbi → workspace_preference_topic_create_request.rbi}

@@ -2,18 +2,20 @@
 
 module Courier
   module Models
-    class PreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceTopicCreateRequest,
+            Courier::WorkspacePreferenceTopicCreateRequest,
             Courier::Internal::AnyHash
           )
         end
 
       # The default subscription status applied when a recipient has not set their own.
       sig do
-        returns(Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol)
+        returns(
+          Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol
+        )
       end
       attr_accessor :default_status
 
@@ -27,7 +29,7 @@ module Courier
         returns(
           T.nilable(
             T::Array[
-              Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+              Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
             ]
           )
         )
@@ -52,12 +54,12 @@ module Courier
       sig do
         params(
           default_status:
-            Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+            Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
           name: String,
           allowed_preferences:
             T.nilable(
               T::Array[
-                Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
               ]
             ),
           include_unsubscribe_header: T.nilable(T::Boolean),
@@ -87,12 +89,12 @@ module Courier
         override.returns(
           {
             default_status:
-              Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+              Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
             name: String,
             allowed_preferences:
               T.nilable(
                 T::Array[
-                  Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                  Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
                 ]
               ),
             include_unsubscribe_header: T.nilable(T::Boolean),
@@ -111,30 +113,33 @@ module Courier
 
         TaggedSymbol =
           T.type_alias do
-            T.all(Symbol, Courier::PreferenceTopicCreateRequest::DefaultStatus)
+            T.all(
+              Symbol,
+              Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus
+            )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         OPTED_OUT =
           T.let(
             :OPTED_OUT,
-            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
           )
         OPTED_IN =
           T.let(
             :OPTED_IN,
-            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
           )
         REQUIRED =
           T.let(
             :REQUIRED,
-            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+              Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
             ]
           )
         end
@@ -150,7 +155,7 @@ module Courier
           T.type_alias do
             T.all(
               Symbol,
-              Courier::PreferenceTopicCreateRequest::AllowedPreference
+              Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference
             )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -158,18 +163,18 @@ module Courier
         SNOOZE =
           T.let(
             :snooze,
-            Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
           )
         CHANNEL_PREFERENCES =
           T.let(
             :channel_preferences,
-            Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+              Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
             ]
           )
         end