trycourier 6.4.3 → 6.4.4

data/rbi/courier/models/elemental_node_non_channel.rbi

@@ -0,0 +1,561 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Any Elemental node except a channel block. Channel elements are only valid as
+    # top-level elements, so the `elements` nested inside one can never be another
+    # channel. Keeping this union channel-free also keeps the schema acyclic; a
+    # recursive `$ref` here breaks the generated Python models.
+    module ElementalNodeNonChannel
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::ElementalNodeNonChannel::UnionMember0,
+            Courier::ElementalNodeNonChannel::UnionMember1,
+            Courier::ElementalNodeNonChannel::UnionMember2,
+            Courier::ElementalNodeNonChannel::UnionMember3,
+            Courier::ElementalNodeNonChannel::UnionMember4,
+            Courier::ElementalNodeNonChannel::UnionMember5,
+            Courier::ElementalNodeNonChannel::UnionMember6
+          )
+        end
+
+      class UnionMember0 < Courier::Models::ElementalTextNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember0,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember0::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember0::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Represents a body of text to be rendered inside of the notification.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember0::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember0::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember0::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TEXT =
+            T.let(
+              :text,
+              Courier::ElementalNodeNonChannel::UnionMember0::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember0::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember1 < Courier::Models::ElementalMetaNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember1,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember1::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember1::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # The meta element contains information describing the notification that may be
+        # used by a particular channel or provider. One important field is the title field
+        # which will be used as the title for channels that support it.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember1::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember1::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember1::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          META =
+            T.let(
+              :meta,
+              Courier::ElementalNodeNonChannel::UnionMember1::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember1::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember2 < Courier::Models::ElementalImageNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember2,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember2::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember2::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Used to embed an image into the notification.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember2::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember2::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember2::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMAGE =
+            T.let(
+              :image,
+              Courier::ElementalNodeNonChannel::UnionMember2::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember2::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember3 < Courier::Models::ElementalActionNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember3,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember3::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember3::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Allows the user to execute an action. Can be a button or a link.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember3::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember3::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember3::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTION =
+            T.let(
+              :action,
+              Courier::ElementalNodeNonChannel::UnionMember3::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember3::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember4 < Courier::Models::ElementalDividerNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember4,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember4::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember4::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Renders a dividing line between elements.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember4::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember4::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember4::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DIVIDER =
+            T.let(
+              :divider,
+              Courier::ElementalNodeNonChannel::UnionMember4::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember4::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember5 < Courier::Models::ElementalQuoteNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember5,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember5::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember5::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Renders a quote block.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember5::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember5::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember5::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          QUOTE =
+            T.let(
+              :quote,
+              Courier::ElementalNodeNonChannel::UnionMember5::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember5::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class UnionMember6 < Courier::Models::ElementalHTMLNode
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementalNodeNonChannel::UnionMember6,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::ElementalNodeNonChannel::UnionMember6::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember6::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # Raw HTML string inside an Elemental document. When rendering a message, this
+        # node is turned into output only for the email channel; for other channels it
+        # produces no blocks.
+        sig do
+          params(
+            type: Courier::ElementalNodeNonChannel::UnionMember6::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Courier::ElementalNodeNonChannel::UnionMember6::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::ElementalNodeNonChannel::UnionMember6::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HTML =
+            T.let(
+              :html,
+              Courier::ElementalNodeNonChannel::UnionMember6::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::ElementalNodeNonChannel::UnionMember6::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Courier::ElementalNodeNonChannel::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_update_request.rbi

@@ -39,9 +39,12 @@ module Courier
       end
       attr_writer :state
 
-      # Request body for replacing a notification template. Same shape as create. All
-      # fields required (PUT = full replacement), except `alias`, whose omission means
-      # "leave the existing aliases alone".
+      # Request body for replacing a notification template. All fields are required,
+      # since `PUT` is a full replacement, except `alias`, whose omission leaves the
+      # existing aliases in place. Unlike `NotificationTemplateCreateRequest`,
+      # `notification.content` is not required to place its elements inside a channel
+      # block: the requirement applies to creation only, so templates already stored
+      # without one stay editable.
       sig do
         params(
           notification: Courier::NotificationTemplateWritePayload::OrHash,

data/rbi/courier/models.rbi

@@ -192,6 +192,8 @@ module Courier
 
   ElementalNode = Courier::Models::ElementalNode
 
+  ElementalNodeNonChannel = Courier::Models::ElementalNodeNonChannel
+
   ElementalQuoteNode = Courier::Models::ElementalQuoteNode
 
   ElementalQuoteNodeWithType = Courier::Models::ElementalQuoteNodeWithType

data/rbi/courier/resources/journeys/templates.rbi

@@ -8,6 +8,13 @@ module Courier
       class Templates
         # Create a notification template scoped to this journey. Defaults to `DRAFT`
         # state; pass `state: "PUBLISHED"` to publish on create.
+        #
+        # The content tree must contain exactly one channel block whose `channel` matches
+        # the `channel` on the request — a journey-scoped template carries a single
+        # channel. Top-level elements, or a block for a different channel, return `400`.
+        # The template designer renders only the channel block matching the tab it draws,
+        # so content stored without one cannot be opened. An empty `elements` array is
+        # accepted.
         sig do
           params(
             template_id: String,

data/rbi/courier/resources/notifications.rbi

@@ -12,6 +12,16 @@ module Courier
 
       # Create a notification template. Requires all fields in the notification object.
       # Templates are created in draft state by default.
+      #
+      # Content must place its elements inside a channel block —
+      # `{ "type": "channel", "channel": "email", "elements": [...] }` — or the request
+      # returns `400`. The template designer renders only the channel block matching the
+      # tab it draws, so content stored without one cannot be opened. An empty
+      # `elements` array is accepted, and the requirement applies to creation only:
+      # `PUT /notifications/{id}` still accepts unwrapped content. Note this endpoint
+      # takes versioned content only — the `{ title, body }` shorthand accepted by
+      # `/send` is rejected here with an `invalid_request_error` on
+      # `notification.content.version`.
       sig do
         params(
           notification: Courier::NotificationTemplateWritePayload::OrHash,

data/rbi/courier/resources/tenants/templates.rbi

@@ -92,6 +92,16 @@ module Courier
 
         # Creates or updates a notification template scoped to one tenant, letting a
         # tenant override the content the workspace template would send.
+        #
+        # This is an upsert: it creates when the tenant has no template under
+        # `template_id`, and updates when it does. On the create half, content must place
+        # its elements inside a channel block —
+        # `{ "type": "channel", "channel": "email", "elements": [...] }` — or the request
+        # returns `400`. The template designer renders only the channel block matching the
+        # tab it draws, so content stored without one cannot be opened. An empty
+        # `elements` array is accepted, as is the `{ title, body }` shorthand, which has
+        # no elements to wrap. Updates are not checked, so tenant templates already stored
+        # without a wrapper stay editable.
         sig do
           params(
             template_id: String,

data/sig/courier/models/elemental_channel_node.rbs

@@ -3,6 +3,7 @@ module Courier
     type elemental_channel_node =
       {
         channel: String,
+        elements: ::Array[Courier::Models::elemental_node_non_channel]?,
         font_size: String?,
         line_height: String?,
         padding: String?,
@@ -14,6 +15,12 @@ module Courier
 
       def channel=: (String _) -> String
 
+      def elements: -> ::Array[Courier::Models::elemental_node_non_channel]?
+
+      def elements=: (
+        ::Array[Courier::Models::elemental_node_non_channel]? _
+      ) -> ::Array[Courier::Models::elemental_node_non_channel]?
+
       def font_size: -> String?
 
       def font_size=: (String? _) -> String?
@@ -32,6 +39,7 @@ module Courier
 
       def initialize: (
         ?channel: String,
+        ?elements: ::Array[Courier::Models::elemental_node_non_channel]?,
         ?font_size: String?,
         ?line_height: String?,
         ?padding: String?,
@@ -40,6 +48,7 @@ module Courier
 
       def to_hash: -> {
         channel: String,
+        elements: ::Array[Courier::Models::elemental_node_non_channel]?,
         font_size: String?,
         line_height: String?,
         padding: String?,