trycourier 6.3.0 → 6.4.1

data/rbi/courier/models/elemental_image_node.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalImageNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalImageNode, Courier::Internal::AnyHash)
+        end
+
+      # The source of the image.
+      sig { returns(String) }
+      attr_accessor :src
+
+      # The alignment of the image.
+      sig { returns(T.nilable(Courier::Alignment::OrSymbol)) }
+      attr_accessor :align
+
+      # Alternate text for the image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :alt_text
+
+      # CSS border color applied to the image. For example, `#ccc`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_color
+
+      # CSS border width applied to the image. For example, `1px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_size
+
+      # A URL to link to when the image is clicked.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :href
+
+      # CSS padding applied around the image. For example, `10px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :padding
+
+      # CSS width properties to apply to the image. For example, 50px
+      sig { returns(T.nilable(String)) }
+      attr_accessor :width
+
+      # Used to embed an image into the notification.
+      sig do
+        params(
+          src: String,
+          align: T.nilable(Courier::Alignment::OrSymbol),
+          alt_text: T.nilable(String),
+          border_color: T.nilable(String),
+          border_size: T.nilable(String),
+          href: T.nilable(String),
+          padding: T.nilable(String),
+          width: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The source of the image.
+        src:,
+        # The alignment of the image.
+        align: nil,
+        # Alternate text for the image.
+        alt_text: nil,
+        # CSS border color applied to the image. For example, `#ccc`
+        border_color: nil,
+        # CSS border width applied to the image. For example, `1px`
+        border_size: nil,
+        # A URL to link to when the image is clicked.
+        href: nil,
+        # CSS padding applied around the image. For example, `10px`
+        padding: nil,
+        # CSS width properties to apply to the image. For example, 50px
+        width: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            src: String,
+            align: T.nilable(Courier::Alignment::OrSymbol),
+            alt_text: T.nilable(String),
+            border_color: T.nilable(String),
+            border_size: T.nilable(String),
+            href: T.nilable(String),
+            padding: T.nilable(String),
+            width: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_image_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalImageNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalImageNodeWithType < Courier::Models::ElementalImageNode
       OrHash =
         T.type_alias do
           T.any(Courier::ElementalImageNodeWithType, Courier::Internal::AnyHash)
@@ -18,6 +18,7 @@ module Courier
       end
       attr_writer :type
 
+      # Used to embed an image into the notification.
       sig do
         params(
           type: Courier::ElementalImageNodeWithType::Type::OrSymbol

data/rbi/courier/models/elemental_meta_node.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalMetaNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalMetaNode, Courier::Internal::AnyHash)
+        end
+
+      # The title to be displayed by supported channels. For example, the email subject.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # 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 { params(title: T.nilable(String)).returns(T.attached_class) }
+      def self.new(
+        # The title to be displayed by supported channels. For example, the email subject.
+        title: nil
+      )
+      end
+
+      sig { override.returns({ title: T.nilable(String) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_meta_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalMetaNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalMetaNodeWithType < Courier::Models::ElementalMetaNode
       OrHash =
         T.type_alias do
           T.any(Courier::ElementalMetaNodeWithType, Courier::Internal::AnyHash)
@@ -18,6 +18,9 @@ module Courier
       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::ElementalMetaNodeWithType::Type::OrSymbol

data/rbi/courier/models/elemental_node.rbi

@@ -2,16 +2,7 @@
 
 module Courier
   module Models
-    # The channel element allows a notification to be customized based on which
-    # channel it is sent through. For example, you may want to display a detailed
-    # message when the notification is sent through email, and a more concise message
-    # in a push notification. Channel elements are only valid as top-level elements;
-    # you cannot nest channel elements. If there is a channel element specified at the
-    # top-level of the document, all sibling elements must be channel elements. Note:
-    # As an alternative, most elements support a `channel` property. Which allows you
-    # to selectively display an individual element on a per channel basis. See the
-    # [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-    # for more details.
+    # Represents a body of text to be rendered inside of the notification.
     module ElementalNode
       extend Courier::Internal::Type::Union
 

data/rbi/courier/models/elemental_quote_node.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalQuoteNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalQuoteNode, Courier::Internal::AnyHash)
+        end
+
+      # The text value of the quote.
+      sig { returns(String) }
+      attr_accessor :content
+
+      # Alignment of the quote.
+      sig { returns(T.nilable(Courier::Alignment::OrSymbol)) }
+      attr_accessor :align
+
+      # CSS border color property. For example, `#fff`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_color
+
+      # CSS px font size for this quote block, e.g. `16px`. Overrides the size of the
+      # `text_style` preset. Email only.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :font_size
+
+      # CSS line height for this quote block, as a px value or a unitless multiplier,
+      # e.g. `24px` or `1.5`. Email only.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :line_height
+
+      # Region specific content. See
+      # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+      # for more details.
+      sig { returns(T.nilable(T::Hash[Symbol, Courier::LocaleItem])) }
+      attr_accessor :locales
+
+      sig { returns(T.nilable(Courier::TextStyle::OrSymbol)) }
+      attr_reader :text_style
+
+      sig { params(text_style: Courier::TextStyle::OrSymbol).void }
+      attr_writer :text_style
+
+      # Renders a quote block.
+      sig do
+        params(
+          content: String,
+          align: T.nilable(Courier::Alignment::OrSymbol),
+          border_color: T.nilable(String),
+          font_size: T.nilable(String),
+          line_height: T.nilable(String),
+          locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem::OrHash]),
+          text_style: Courier::TextStyle::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The text value of the quote.
+        content:,
+        # Alignment of the quote.
+        align: nil,
+        # CSS border color property. For example, `#fff`
+        border_color: nil,
+        # CSS px font size for this quote block, e.g. `16px`. Overrides the size of the
+        # `text_style` preset. Email only.
+        font_size: nil,
+        # CSS line height for this quote block, as a px value or a unitless multiplier,
+        # e.g. `24px` or `1.5`. Email only.
+        line_height: nil,
+        # Region specific content. See
+        # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+        # for more details.
+        locales: nil,
+        text_style: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: String,
+            align: T.nilable(Courier::Alignment::OrSymbol),
+            border_color: T.nilable(String),
+            font_size: T.nilable(String),
+            line_height: T.nilable(String),
+            locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem]),
+            text_style: Courier::TextStyle::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_quote_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalQuoteNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalQuoteNodeWithType < Courier::Models::ElementalQuoteNode
       OrHash =
         T.type_alias do
           T.any(Courier::ElementalQuoteNodeWithType, Courier::Internal::AnyHash)
@@ -18,6 +18,7 @@ module Courier
       end
       attr_writer :type
 
+      # Renders a quote block.
       sig do
         params(
           type: Courier::ElementalQuoteNodeWithType::Type::OrSymbol

data/rbi/courier/models/elemental_text_node.rbi

@@ -0,0 +1,177 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalTextNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalTextNode, Courier::Internal::AnyHash)
+        end
+
+      # The text content displayed in the notification. Either this field must be
+      # specified, or the elements field
+      sig { returns(String) }
+      attr_accessor :content
+
+      # Text alignment.
+      sig { returns(T.nilable(Courier::ElementalTextNode::Align::OrSymbol)) }
+      attr_reader :align
+
+      sig { params(align: Courier::ElementalTextNode::Align::OrSymbol).void }
+      attr_writer :align
+
+      # Apply bold to the text
+      sig { returns(T.nilable(String)) }
+      attr_accessor :bold
+
+      # Specifies the color of text. Can be any valid css color value
+      sig { returns(T.nilable(String)) }
+      attr_accessor :color
+
+      # CSS px font size for this text block, e.g. `16px`. Overrides the size of the
+      # `text_style` preset. Email only.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :font_size
+
+      sig { returns(T.nilable(Courier::ElementalTextNode::Format::OrSymbol)) }
+      attr_accessor :format_
+
+      # Apply italics to the text
+      sig { returns(T.nilable(String)) }
+      attr_accessor :italic
+
+      # CSS line height for this text block, as a px value or a unitless multiplier,
+      # e.g. `24px` or `1.5`. Email only.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :line_height
+
+      # Region specific content. See
+      # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+      # for more details.
+      sig { returns(T.nilable(T::Hash[Symbol, Courier::LocaleItem])) }
+      attr_accessor :locales
+
+      # Apply a strike through the text
+      sig { returns(T.nilable(String)) }
+      attr_accessor :strikethrough
+
+      # Allows the text to be rendered as a heading level.
+      sig { returns(T.nilable(Courier::TextStyle::OrSymbol)) }
+      attr_accessor :text_style
+
+      # Apply an underline to the text
+      sig { returns(T.nilable(String)) }
+      attr_accessor :underline
+
+      # Represents a body of text to be rendered inside of the notification.
+      sig do
+        params(
+          content: String,
+          align: Courier::ElementalTextNode::Align::OrSymbol,
+          bold: T.nilable(String),
+          color: T.nilable(String),
+          font_size: T.nilable(String),
+          format_: T.nilable(Courier::ElementalTextNode::Format::OrSymbol),
+          italic: T.nilable(String),
+          line_height: T.nilable(String),
+          locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem::OrHash]),
+          strikethrough: T.nilable(String),
+          text_style: T.nilable(Courier::TextStyle::OrSymbol),
+          underline: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The text content displayed in the notification. Either this field must be
+        # specified, or the elements field
+        content:,
+        # Text alignment.
+        align: nil,
+        # Apply bold to the text
+        bold: nil,
+        # Specifies the color of text. Can be any valid css color value
+        color: nil,
+        # CSS px font size for this text block, e.g. `16px`. Overrides the size of the
+        # `text_style` preset. Email only.
+        font_size: nil,
+        format_: nil,
+        # Apply italics to the text
+        italic: nil,
+        # CSS line height for this text block, as a px value or a unitless multiplier,
+        # e.g. `24px` or `1.5`. Email only.
+        line_height: nil,
+        # Region specific content. See
+        # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+        # for more details.
+        locales: nil,
+        # Apply a strike through the text
+        strikethrough: nil,
+        # Allows the text to be rendered as a heading level.
+        text_style: nil,
+        # Apply an underline to the text
+        underline: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: String,
+            align: Courier::ElementalTextNode::Align::OrSymbol,
+            bold: T.nilable(String),
+            color: T.nilable(String),
+            font_size: T.nilable(String),
+            format_: T.nilable(Courier::ElementalTextNode::Format::OrSymbol),
+            italic: T.nilable(String),
+            line_height: T.nilable(String),
+            locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem]),
+            strikethrough: T.nilable(String),
+            text_style: T.nilable(Courier::TextStyle::OrSymbol),
+            underline: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Text alignment.
+      module Align
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::ElementalTextNode::Align) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LEFT = T.let(:left, Courier::ElementalTextNode::Align::TaggedSymbol)
+        CENTER = T.let(:center, Courier::ElementalTextNode::Align::TaggedSymbol)
+        RIGHT = T.let(:right, Courier::ElementalTextNode::Align::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalTextNode::Align::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Format
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::ElementalTextNode::Format) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MARKDOWN =
+          T.let(:markdown, Courier::ElementalTextNode::Format::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalTextNode::Format::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_text_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalTextNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalTextNodeWithType < Courier::Models::ElementalTextNode
       OrHash =
         T.type_alias do
           T.any(Courier::ElementalTextNodeWithType, Courier::Internal::AnyHash)
@@ -18,6 +18,7 @@ module Courier
       end
       attr_writer :type
 
+      # Represents a body of text to be rendered inside of the notification.
       sig do
         params(
           type: Courier::ElementalTextNodeWithType::Type::OrSymbol

data/rbi/courier/models/journey_send_node.rbi

@@ -23,6 +23,16 @@ module Courier
       sig { params(id: String).void }
       attr_writer :id
 
+      # The channel this node sends through. Optional — when omitted, the field is
+      # absent from the node, including on `GET`; nodes created before this field
+      # existed have it unset. Setting it makes the node's channel explicit to any
+      # client reading the journey.
+      sig { returns(T.nilable(Courier::JourneySendNode::Channel::OrSymbol)) }
+      attr_reader :channel
+
+      sig { params(channel: Courier::JourneySendNode::Channel::OrSymbol).void }
+      attr_writer :channel
+
       # 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".
@@ -70,6 +80,7 @@ module Courier
           message: Courier::JourneySendNode::Message::OrHash,
           type: Courier::JourneySendNode::Type::OrSymbol,
           id: String,
+          channel: Courier::JourneySendNode::Channel::OrSymbol,
           conditions:
             T.any(
               T::Array[String],
@@ -83,6 +94,11 @@ module Courier
         message:,
         type:,
         id: nil,
+        # The channel this node sends through. Optional — when omitted, the field is
+        # absent from the node, including on `GET`; nodes created before this field
+        # existed have it unset. Setting it makes the node's channel explicit to any
+        # client reading the journey.
+        channel: 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".
@@ -100,6 +116,7 @@ module Courier
             message: Courier::JourneySendNode::Message,
             type: Courier::JourneySendNode::Type::OrSymbol,
             id: String,
+            channel: Courier::JourneySendNode::Channel::OrSymbol,
             conditions:
               T.any(
                 T::Array[String],
@@ -417,6 +434,34 @@ module Courier
         def self.values
         end
       end
+
+      # The channel this node sends through. Optional — when omitted, the field is
+      # absent from the node, including on `GET`; nodes created before this field
+      # existed have it unset. Setting it makes the node's channel explicit to any
+      # client reading the journey.
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::JourneySendNode::Channel) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL = T.let(:email, Courier::JourneySendNode::Channel::TaggedSymbol)
+        SMS = T.let(:sms, Courier::JourneySendNode::Channel::TaggedSymbol)
+        PUSH = T.let(:push, Courier::JourneySendNode::Channel::TaggedSymbol)
+        INBOX = T.let(:inbox, Courier::JourneySendNode::Channel::TaggedSymbol)
+        SLACK = T.let(:slack, Courier::JourneySendNode::Channel::TaggedSymbol)
+        MSTEAMS =
+          T.let(:msteams, Courier::JourneySendNode::Channel::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneySendNode::Channel::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/courier/models/locales.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class LocaleItem < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::LocaleItem, Courier::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :content
+
+      sig { params(content: String).returns(T.attached_class) }
+      def self.new(content:)
+      end
+
+      sig { override.returns({ content: String }) }
+      def to_hash
+      end
+    end
+
+    Locales =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::LocaleItem],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models.rbi

@@ -160,6 +160,8 @@ module Courier
 
   Discord = Courier::Models::Discord
 
+  ElementalActionNode = Courier::Models::ElementalActionNode
+
   ElementalActionNodeWithType = Courier::Models::ElementalActionNodeWithType
 
   ElementalBaseNode = Courier::Models::ElementalBaseNode
@@ -172,18 +174,30 @@ module Courier
 
   ElementalContentSugar = Courier::Models::ElementalContentSugar
 
+  ElementalDividerNode = Courier::Models::ElementalDividerNode
+
   ElementalDividerNodeWithType = Courier::Models::ElementalDividerNodeWithType
 
+  ElementalHTMLNode = Courier::Models::ElementalHTMLNode
+
   ElementalHTMLNodeWithType = Courier::Models::ElementalHTMLNodeWithType
 
+  ElementalImageNode = Courier::Models::ElementalImageNode
+
   ElementalImageNodeWithType = Courier::Models::ElementalImageNodeWithType
 
+  ElementalMetaNode = Courier::Models::ElementalMetaNode
+
   ElementalMetaNodeWithType = Courier::Models::ElementalMetaNodeWithType
 
   ElementalNode = Courier::Models::ElementalNode
 
+  ElementalQuoteNode = Courier::Models::ElementalQuoteNode
+
   ElementalQuoteNodeWithType = Courier::Models::ElementalQuoteNodeWithType
 
+  ElementalTextNode = Courier::Models::ElementalTextNode
+
   ElementalTextNodeWithType = Courier::Models::ElementalTextNodeWithType
 
   ElementWithChecksums = Courier::Models::ElementWithChecksums
@@ -346,6 +360,10 @@ module Courier
 
   ListUpdateParams = Courier::Models::ListUpdateParams
 
+  LocaleItem = Courier::Models::LocaleItem
+
+  Locales = T.let(Courier::Models::Locales, Courier::Internal::Type::Converter)
+
   Logo = Courier::Models::Logo
 
   MessageCancelParams = Courier::Models::MessageCancelParams