trycourier 6.4.0 → 6.4.1

data/lib/courier/models/elemental_text_node.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalTextNode < Courier::Models::ElementalBaseNode
+      # @!attribute content
+      #   The text content displayed in the notification. Either this field must be
+      #   specified, or the elements field
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!attribute align
+      #   Text alignment.
+      #
+      #   @return [Symbol, Courier::Models::ElementalTextNode::Align, nil]
+      optional :align, enum: -> { Courier::ElementalTextNode::Align }
+
+      # @!attribute bold
+      #   Apply bold to the text
+      #
+      #   @return [String, nil]
+      optional :bold, String, nil?: true
+
+      # @!attribute color
+      #   Specifies the color of text. Can be any valid css color value
+      #
+      #   @return [String, nil]
+      optional :color, String, nil?: true
+
+      # @!attribute font_size
+      #   CSS px font size for this text block, e.g. `16px`. Overrides the size of the
+      #   `text_style` preset. Email only.
+      #
+      #   @return [String, nil]
+      optional :font_size, String, nil?: true
+
+      # @!attribute format_
+      #
+      #   @return [Symbol, Courier::Models::ElementalTextNode::Format, nil]
+      optional :format_, enum: -> { Courier::ElementalTextNode::Format }, api_name: :format, nil?: true
+
+      # @!attribute italic
+      #   Apply italics to the text
+      #
+      #   @return [String, nil]
+      optional :italic, String, nil?: true
+
+      # @!attribute line_height
+      #   CSS line height for this text block, as a px value or a unitless multiplier,
+      #   e.g. `24px` or `1.5`. Email only.
+      #
+      #   @return [String, nil]
+      optional :line_height, String, nil?: true
+
+      # @!attribute locales
+      #   Region specific content. See
+      #   [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+      #   for more details.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::LocaleItem}, nil]
+      optional :locales, -> { Courier::Internal::Type::HashOf[Courier::LocaleItem] }, nil?: true
+
+      # @!attribute strikethrough
+      #   Apply a strike through the text
+      #
+      #   @return [String, nil]
+      optional :strikethrough, String, nil?: true
+
+      # @!attribute text_style
+      #   Allows the text to be rendered as a heading level.
+      #
+      #   @return [Symbol, Courier::Models::TextStyle, nil]
+      optional :text_style, enum: -> { Courier::TextStyle }, nil?: true
+
+      # @!attribute underline
+      #   Apply an underline to the text
+      #
+      #   @return [String, nil]
+      optional :underline, String, nil?: true
+
+      # @!method initialize(content:, align: nil, bold: nil, color: nil, font_size: nil, format_: nil, italic: nil, line_height: nil, locales: nil, strikethrough: nil, text_style: nil, underline: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ElementalTextNode} for more details.
+      #
+      #   Represents a body of text to be rendered inside of the notification.
+      #
+      #   @param content [String] The text content displayed in the notification. Either this
+      #
+      #   @param align [Symbol, Courier::Models::ElementalTextNode::Align] Text alignment.
+      #
+      #   @param bold [String, nil] Apply bold to the text
+      #
+      #   @param color [String, nil] Specifies the color of text. Can be any valid css color value
+      #
+      #   @param font_size [String, nil] CSS px font size for this text block, e.g. `16px`. Overrides the size of the `te
+      #
+      #   @param format_ [Symbol, Courier::Models::ElementalTextNode::Format, nil]
+      #
+      #   @param italic [String, nil] Apply italics to the text
+      #
+      #   @param line_height [String, nil] CSS line height for this text block, as a px value or a unitless multiplier, e.g
+      #
+      #   @param locales [Hash{Symbol=>Courier::Models::LocaleItem}, nil] Region specific content. See [locales docs](https://www.courier.com/docs/platfor
+      #
+      #   @param strikethrough [String, nil] Apply a strike through the text
+      #
+      #   @param text_style [Symbol, Courier::Models::TextStyle, nil] Allows the text to be rendered as a heading level.
+      #
+      #   @param underline [String, nil] Apply an underline to the text
+
+      # Text alignment.
+      module Align
+        extend Courier::Internal::Type::Enum
+
+        LEFT = :left
+        CENTER = :center
+        RIGHT = :right
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Format
+        extend Courier::Internal::Type::Enum
+
+        MARKDOWN = :markdown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/elemental_text_node_with_type.rb

@@ -2,13 +2,15 @@
 
 module Courier
   module Models
-    class ElementalTextNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalTextNodeWithType < Courier::Models::ElementalTextNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalTextNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalTextNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   Represents a body of text to be rendered inside of the notification.
+      #
       #   @param type [Symbol, Courier::Models::ElementalTextNodeWithType::Type]
 
       module Type

data/lib/courier/models/locales.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class LocaleItem < Courier::Internal::Type::BaseModel
+      # @!attribute content
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!method initialize(content:)
+      #   @param content [String]
+    end
+
+    # @type [Courier::Internal::Type::Converter]
+    Locales = Courier::Internal::Type::HashOf[-> { Courier::LocaleItem }]
+  end
+end

data/lib/courier/models.rb

@@ -195,6 +195,8 @@ module Courier
 
   Discord = Courier::Models::Discord
 
+  ElementalActionNode = Courier::Models::ElementalActionNode
+
   ElementalActionNodeWithType = Courier::Models::ElementalActionNodeWithType
 
   ElementalBaseNode = Courier::Models::ElementalBaseNode
@@ -207,18 +209,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
@@ -378,6 +392,11 @@ module Courier
 
   ListUpdateParams = Courier::Models::ListUpdateParams
 
+  LocaleItem = Courier::Models::LocaleItem
+
+  # @type [Courier::Internal::Type::Converter]
+  Locales = Courier::Models::Locales
+
   Logo = Courier::Models::Logo
 
   MessageCancelParams = Courier::Models::MessageCancelParams

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "6.4.0"
+  VERSION = "6.4.1"
 end

data/lib/courier.rb

@@ -62,7 +62,14 @@ require_relative "courier/models/update_broadcast_request"
 require_relative "courier/models/inbound_bulk_message_user"
 require_relative "courier/models/base_check"
 require_relative "courier/models/subscription_topic_new"
+require_relative "courier/models/elemental_action_node"
 require_relative "courier/models/elemental_channel_node"
+require_relative "courier/models/elemental_divider_node"
+require_relative "courier/models/elemental_html_node"
+require_relative "courier/models/elemental_image_node"
+require_relative "courier/models/elemental_meta_node"
+require_relative "courier/models/elemental_quote_node"
+require_relative "courier/models/elemental_text_node"
 require_relative "courier/models/cancel_journey_request"
 require_relative "courier/models/create_journey_request"
 require_relative "courier/models/journeys_invoke_request"
@@ -275,6 +282,7 @@ require_relative "courier/models/lists/subscription_subscribe_params"
 require_relative "courier/models/lists/subscription_subscribe_user_params"
 require_relative "courier/models/lists/subscription_unsubscribe_user_params"
 require_relative "courier/models/list_update_params"
+require_relative "courier/models/locales"
 require_relative "courier/models/logo"
 require_relative "courier/models/message_cancel_params"
 require_relative "courier/models/message_channels"

data/rbi/courier/models/elemental_action_node.rbi

@@ -0,0 +1,153 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalActionNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalActionNode, Courier::Internal::AnyHash)
+        end
+
+      # The text content of the action shown to the user.
+      sig { returns(String) }
+      attr_accessor :content
+
+      # The target URL of the action.
+      sig { returns(String) }
+      attr_accessor :href
+
+      # A unique id used to identify the action when it is executed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :action_id
+
+      # The alignment of the action button. Defaults to "center".
+      sig { returns(T.nilable(Courier::Alignment::OrSymbol)) }
+      attr_accessor :align
+
+      # The background color of the action button.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :background_color
+
+      # CSS border-radius applied to the action button. For example, `4px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_radius
+
+      # CSS border width applied to the action button. For example, `1px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :border_size
+
+      # When true, the action's href is not rewritten for click-through tracking, even
+      # when click-through tracking is enabled for the workspace.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :disable_tracking
+
+      # CSS font-size applied to the action button label. For example, `14px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :font_size
+
+      # 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
+
+      # CSS padding applied to the action button. For example, `8px 16px`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :padding
+
+      # Defaults to `button`.
+      sig { returns(T.nilable(Courier::ElementalActionNode::Style::OrSymbol)) }
+      attr_accessor :style
+
+      # Allows the user to execute an action. Can be a button or a link.
+      sig do
+        params(
+          content: String,
+          href: String,
+          action_id: T.nilable(String),
+          align: T.nilable(Courier::Alignment::OrSymbol),
+          background_color: T.nilable(String),
+          border_radius: T.nilable(String),
+          border_size: T.nilable(String),
+          disable_tracking: T.nilable(T::Boolean),
+          font_size: T.nilable(String),
+          locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem::OrHash]),
+          padding: T.nilable(String),
+          style: T.nilable(Courier::ElementalActionNode::Style::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The text content of the action shown to the user.
+        content:,
+        # The target URL of the action.
+        href:,
+        # A unique id used to identify the action when it is executed.
+        action_id: nil,
+        # The alignment of the action button. Defaults to "center".
+        align: nil,
+        # The background color of the action button.
+        background_color: nil,
+        # CSS border-radius applied to the action button. For example, `4px`
+        border_radius: nil,
+        # CSS border width applied to the action button. For example, `1px`
+        border_size: nil,
+        # When true, the action's href is not rewritten for click-through tracking, even
+        # when click-through tracking is enabled for the workspace.
+        disable_tracking: nil,
+        # CSS font-size applied to the action button label. For example, `14px`
+        font_size: nil,
+        # Region specific content. See
+        # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+        # for more details.
+        locales: nil,
+        # CSS padding applied to the action button. For example, `8px 16px`
+        padding: nil,
+        # Defaults to `button`.
+        style: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: String,
+            href: String,
+            action_id: T.nilable(String),
+            align: T.nilable(Courier::Alignment::OrSymbol),
+            background_color: T.nilable(String),
+            border_radius: T.nilable(String),
+            border_size: T.nilable(String),
+            disable_tracking: T.nilable(T::Boolean),
+            font_size: T.nilable(String),
+            locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem]),
+            padding: T.nilable(String),
+            style: T.nilable(Courier::ElementalActionNode::Style::OrSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Defaults to `button`.
+      module Style
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::ElementalActionNode::Style) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BUTTON =
+          T.let(:button, Courier::ElementalActionNode::Style::TaggedSymbol)
+        LINK = T.let(:link, Courier::ElementalActionNode::Style::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalActionNode::Style::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_action_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalActionNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalActionNodeWithType < Courier::Models::ElementalActionNode
       OrHash =
         T.type_alias do
           T.any(
@@ -21,6 +21,7 @@ module Courier
       end
       attr_writer :type
 
+      # Allows the user to execute an action. Can be a button or a link.
       sig do
         params(
           type: Courier::ElementalActionNodeWithType::Type::OrSymbol

data/rbi/courier/models/elemental_divider_node.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalDividerNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalDividerNode, Courier::Internal::AnyHash)
+        end
+
+      # The CSS color to render the line with. For example, `#fff`
+      sig { returns(T.nilable(String)) }
+      attr_accessor :color
+
+      # Renders a dividing line between elements.
+      sig { params(color: T.nilable(String)).returns(T.attached_class) }
+      def self.new(
+        # The CSS color to render the line with. For example, `#fff`
+        color: nil
+      )
+      end
+
+      sig { override.returns({ color: T.nilable(String) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_divider_node_with_type.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    class ElementalDividerNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalDividerNodeWithType < Courier::Models::ElementalDividerNode
       OrHash =
         T.type_alias do
           T.any(
@@ -23,6 +23,7 @@ module Courier
       end
       attr_writer :type
 
+      # Renders a dividing line between elements.
       sig do
         params(
           type: Courier::ElementalDividerNodeWithType::Type::OrSymbol

data/rbi/courier/models/elemental_html_node.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalHTMLNode < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalHTMLNode, Courier::Internal::AnyHash)
+        end
+
+      # Raw HTML string to render inside the notification.
+      sig { returns(String) }
+      attr_accessor :content
+
+      # 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
+
+      # 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(
+          content: String,
+          locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem::OrHash])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Raw HTML string to render inside the notification.
+        content:,
+        # Region specific content. See
+        # [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
+        # for more details.
+        locales: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: String,
+            locales: T.nilable(T::Hash[Symbol, Courier::LocaleItem])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_html_node_with_type.rbi

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

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