trycourier 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a40579016778bf7fd2be413c80a59a514bda2c1a2a6de1f6c1649cd6f28ce4
-  data.tar.gz: 071bdbb767a79675af2f55eaaeec7ad23ef5bac415f5d9f9eac2311407ae2a2a
+  metadata.gz: cd58fda1e5a6ef5d937ebea115df994b31e5d97d031123179b496387d827e2ee
+  data.tar.gz: bd5c6708f7bb7495aebb3bcb832a3f41181941cc20cb413bb0deb17251c80a3e
 SHA512:
-  metadata.gz: 0c5d00663ef98a7494db3b618a08b2f9a103355077cfa7e77def4b9f63686c46bbdbb487d7e9184507bb7b5a95bfb739c38864884736aeca01a56a3fd18069db
-  data.tar.gz: 2c2acf11904f5f0234aefbb0f5867ebef9e39787fe16aa5238495e1e221adf39087e62a1d6cd5db185c5810d701feeb7c64434e735830af86657915b02b2a448
+  metadata.gz: f1d5b201bc4086dea717349b8214b77d1d13545b22dcf1c685d6d251ea1fe6a944a4690d61fb7f138ec87c2c699e75dacfd7d54f6d741426b920f0a729ebee36
+  data.tar.gz: ec111124754121db2f8224c142c5c984d8f3dde935e0493e4c15804e32050be3e104d0ae8f95c7432dbc550884e69e6ec92312bf81a0b8ba9b091c038ff1845e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [6.4.1](https://github.com/trycourier/courier-ruby/compare/v6.4.0...v6.4.1) (2026-08-28)
+
+
+### Bug Fixes
+
+* **api:** give Elemental nodes their properties in every SDK ([#140](https://github.com/trycourier/courier-ruby/issues/140)) ([482b8e7](https://github.com/trycourier/courier-ruby/commit/482b8e7c3d9e2cb35f434db538504d4337d79095))
+
 ## [6.4.0](https://github.com/trycourier/courier-ruby/compare/v6.3.0...v6.4.0) (2026-08-28)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 6.4.0"
+gem "trycourier", "~> 6.4.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/models/elemental_action_node.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalActionNode < Courier::Models::ElementalBaseNode
+      # @!attribute content
+      #   The text content of the action shown to the user.
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!attribute href
+      #   The target URL of the action.
+      #
+      #   @return [String]
+      required :href, String
+
+      # @!attribute action_id
+      #   A unique id used to identify the action when it is executed.
+      #
+      #   @return [String, nil]
+      optional :action_id, String, nil?: true
+
+      # @!attribute align
+      #   The alignment of the action button. Defaults to "center".
+      #
+      #   @return [Symbol, Courier::Models::Alignment, nil]
+      optional :align, enum: -> { Courier::Alignment }, nil?: true
+
+      # @!attribute background_color
+      #   The background color of the action button.
+      #
+      #   @return [String, nil]
+      optional :background_color, String, nil?: true
+
+      # @!attribute border_radius
+      #   CSS border-radius applied to the action button. For example, `4px`
+      #
+      #   @return [String, nil]
+      optional :border_radius, String, nil?: true
+
+      # @!attribute border_size
+      #   CSS border width applied to the action button. For example, `1px`
+      #
+      #   @return [String, nil]
+      optional :border_size, String, nil?: true
+
+      # @!attribute disable_tracking
+      #   When true, the action's href is not rewritten for click-through tracking, even
+      #   when click-through tracking is enabled for the workspace.
+      #
+      #   @return [Boolean, nil]
+      optional :disable_tracking, Courier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute font_size
+      #   CSS font-size applied to the action button label. For example, `14px`
+      #
+      #   @return [String, nil]
+      optional :font_size, 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 padding
+      #   CSS padding applied to the action button. For example, `8px 16px`
+      #
+      #   @return [String, nil]
+      optional :padding, String, nil?: true
+
+      # @!attribute style
+      #   Defaults to `button`.
+      #
+      #   @return [Symbol, Courier::Models::ElementalActionNode::Style, nil]
+      optional :style, enum: -> { Courier::ElementalActionNode::Style }, nil?: true
+
+      # @!method initialize(content:, href:, action_id: nil, align: nil, background_color: nil, border_radius: nil, border_size: nil, disable_tracking: nil, font_size: nil, locales: nil, padding: nil, style: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ElementalActionNode} for more details.
+      #
+      #   Allows the user to execute an action. Can be a button or a link.
+      #
+      #   @param content [String] The text content of the action shown to the user.
+      #
+      #   @param href [String] The target URL of the action.
+      #
+      #   @param action_id [String, nil] A unique id used to identify the action when it is executed.
+      #
+      #   @param align [Symbol, Courier::Models::Alignment, nil] The alignment of the action button. Defaults to "center".
+      #
+      #   @param background_color [String, nil] The background color of the action button.
+      #
+      #   @param border_radius [String, nil] CSS border-radius applied to the action button. For example, `4px`
+      #
+      #   @param border_size [String, nil] CSS border width applied to the action button. For example, `1px`
+      #
+      #   @param disable_tracking [Boolean, nil] When true, the action's href is not rewritten for click-through tracking, even w
+      #
+      #   @param font_size [String, nil] CSS font-size applied to the action button label. For example, `14px`
+      #
+      #   @param locales [Hash{Symbol=>Courier::Models::LocaleItem}, nil] Region specific content. See [locales docs](https://www.courier.com/docs/platfor
+      #
+      #   @param padding [String, nil] CSS padding applied to the action button. For example, `8px 16px`
+      #
+      #   @param style [Symbol, Courier::Models::ElementalActionNode::Style, nil] Defaults to `button`.
+
+      # Defaults to `button`.
+      module Style
+        extend Courier::Internal::Type::Enum
+
+        BUTTON = :button
+        LINK = :link
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/elemental_action_node_with_type.rb

@@ -2,13 +2,15 @@
 
 module Courier
   module Models
-    class ElementalActionNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalActionNodeWithType < Courier::Models::ElementalActionNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalActionNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalActionNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   Allows the user to execute an action. Can be a button or a link.
+      #
       #   @param type [Symbol, Courier::Models::ElementalActionNodeWithType::Type]
 
       module Type

data/lib/courier/models/elemental_channel_node.rb

@@ -54,7 +54,7 @@ module Courier
       #   [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
       #   for more details.
       #
-      #   @param channel [String] The channel the contents of this element should be applied to. Can be `email`,
+      #   @param channel [String] The channel the contents of this element should be applied to. Can be `email`, `
       #
       #   @param font_size [String, nil] Email only. Document-level base font size (CSS px, e.g. `16px`) for body content
       #

data/lib/courier/models/elemental_divider_node.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalDividerNode < Courier::Models::ElementalBaseNode
+      # @!attribute color
+      #   The CSS color to render the line with. For example, `#fff`
+      #
+      #   @return [String, nil]
+      optional :color, String, nil?: true
+
+      # @!method initialize(color: nil)
+      #   Renders a dividing line between elements.
+      #
+      #   @param color [String, nil] The CSS color to render the line with. For example, `#fff`
+    end
+  end
+end

data/lib/courier/models/elemental_divider_node_with_type.rb

@@ -2,13 +2,15 @@
 
 module Courier
   module Models
-    class ElementalDividerNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalDividerNodeWithType < Courier::Models::ElementalDividerNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalDividerNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalDividerNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   Renders a dividing line between elements.
+      #
       #   @param type [Symbol, Courier::Models::ElementalDividerNodeWithType::Type]
 
       module Type

data/lib/courier/models/elemental_html_node.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalHTMLNode < Courier::Models::ElementalBaseNode
+      # @!attribute content
+      #   Raw HTML string to render inside the notification.
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!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
+
+      # @!method initialize(content:, locales: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ElementalHTMLNode} for more details.
+      #
+      #   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.
+      #
+      #   @param content [String] Raw HTML string to render inside the notification.
+      #
+      #   @param locales [Hash{Symbol=>Courier::Models::LocaleItem}, nil] Region specific content. See [locales docs](https://www.courier.com/docs/platfor
+    end
+  end
+end

data/lib/courier/models/elemental_html_node_with_type.rb

@@ -2,13 +2,17 @@
 
 module Courier
   module Models
-    class ElementalHTMLNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalHTMLNodeWithType < Courier::Models::ElementalHTMLNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalHTMLNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalHTMLNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   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.
+      #
       #   @param type [Symbol, Courier::Models::ElementalHTMLNodeWithType::Type]
 
       module Type

data/lib/courier/models/elemental_image_node.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalImageNode < Courier::Models::ElementalBaseNode
+      # @!attribute src
+      #   The source of the image.
+      #
+      #   @return [String]
+      required :src, String
+
+      # @!attribute align
+      #   The alignment of the image.
+      #
+      #   @return [Symbol, Courier::Models::Alignment, nil]
+      optional :align, enum: -> { Courier::Alignment }, nil?: true
+
+      # @!attribute alt_text
+      #   Alternate text for the image.
+      #
+      #   @return [String, nil]
+      optional :alt_text, String, api_name: :altText, nil?: true
+
+      # @!attribute border_color
+      #   CSS border color applied to the image. For example, `#ccc`
+      #
+      #   @return [String, nil]
+      optional :border_color, String, nil?: true
+
+      # @!attribute border_size
+      #   CSS border width applied to the image. For example, `1px`
+      #
+      #   @return [String, nil]
+      optional :border_size, String, nil?: true
+
+      # @!attribute href
+      #   A URL to link to when the image is clicked.
+      #
+      #   @return [String, nil]
+      optional :href, String, nil?: true
+
+      # @!attribute padding
+      #   CSS padding applied around the image. For example, `10px`
+      #
+      #   @return [String, nil]
+      optional :padding, String, nil?: true
+
+      # @!attribute width
+      #   CSS width properties to apply to the image. For example, 50px
+      #
+      #   @return [String, nil]
+      optional :width, String, nil?: true
+
+      # @!method initialize(src:, align: nil, alt_text: nil, border_color: nil, border_size: nil, href: nil, padding: nil, width: nil)
+      #   Used to embed an image into the notification.
+      #
+      #   @param src [String] The source of the image.
+      #
+      #   @param align [Symbol, Courier::Models::Alignment, nil] The alignment of the image.
+      #
+      #   @param alt_text [String, nil] Alternate text for the image.
+      #
+      #   @param border_color [String, nil] CSS border color applied to the image. For example, `#ccc`
+      #
+      #   @param border_size [String, nil] CSS border width applied to the image. For example, `1px`
+      #
+      #   @param href [String, nil] A URL to link to when the image is clicked.
+      #
+      #   @param padding [String, nil] CSS padding applied around the image. For example, `10px`
+      #
+      #   @param width [String, nil] CSS width properties to apply to the image. For example, 50px
+    end
+  end
+end

data/lib/courier/models/elemental_image_node_with_type.rb

@@ -2,13 +2,15 @@
 
 module Courier
   module Models
-    class ElementalImageNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalImageNodeWithType < Courier::Models::ElementalImageNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalImageNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalImageNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   Used to embed an image into the notification.
+      #
       #   @param type [Symbol, Courier::Models::ElementalImageNodeWithType::Type]
 
       module Type

data/lib/courier/models/elemental_meta_node.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalMetaNode < Courier::Models::ElementalBaseNode
+      # @!attribute title
+      #   The title to be displayed by supported channels. For example, the email subject.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(title: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ElementalMetaNode} for more details.
+      #
+      #   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.
+      #
+      #   @param title [String, nil] The title to be displayed by supported channels. For example, the email subject.
+    end
+  end
+end

data/lib/courier/models/elemental_meta_node_with_type.rb

@@ -2,13 +2,17 @@
 
 module Courier
   module Models
-    class ElementalMetaNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalMetaNodeWithType < Courier::Models::ElementalMetaNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalMetaNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalMetaNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   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.
+      #
       #   @param type [Symbol, Courier::Models::ElementalMetaNodeWithType::Type]
 
       module Type

data/lib/courier/models/elemental_node.rb

@@ -2,41 +2,32 @@
 
 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
 
+      # Represents a body of text to be rendered inside of the notification.
       variant -> { Courier::ElementalTextNodeWithType }
 
+      # 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.
       variant -> { Courier::ElementalMetaNodeWithType }
 
-      # 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.
+      # 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.
       variant -> { Courier::ElementalChannelNodeWithType }
 
+      # Used to embed an image into the notification.
       variant -> { Courier::ElementalImageNodeWithType }
 
+      # Allows the user to execute an action. Can be a button or a link.
       variant -> { Courier::ElementalActionNodeWithType }
 
+      # Renders a dividing line between elements.
       variant -> { Courier::ElementalDividerNodeWithType }
 
+      # Renders a quote block.
       variant -> { Courier::ElementalQuoteNodeWithType }
 
+      # 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.
       variant -> { Courier::ElementalHTMLNodeWithType }
 
       # @!method self.variants

data/lib/courier/models/elemental_quote_node.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalQuoteNode < Courier::Models::ElementalBaseNode
+      # @!attribute content
+      #   The text value of the quote.
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!attribute align
+      #   Alignment of the quote.
+      #
+      #   @return [Symbol, Courier::Models::Alignment, nil]
+      optional :align, enum: -> { Courier::Alignment }, nil?: true
+
+      # @!attribute border_color
+      #   CSS border color property. For example, `#fff`
+      #
+      #   @return [String, nil]
+      optional :border_color, String, api_name: :borderColor, nil?: true
+
+      # @!attribute font_size
+      #   CSS px font size for this quote block, e.g. `16px`. Overrides the size of the
+      #   `text_style` preset. Email only.
+      #
+      #   @return [String, nil]
+      optional :font_size, String, nil?: true
+
+      # @!attribute line_height
+      #   CSS line height for this quote 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 text_style
+      #
+      #   @return [Symbol, Courier::Models::TextStyle, nil]
+      optional :text_style, enum: -> { Courier::TextStyle }
+
+      # @!method initialize(content:, align: nil, border_color: nil, font_size: nil, line_height: nil, locales: nil, text_style: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ElementalQuoteNode} for more details.
+      #
+      #   Renders a quote block.
+      #
+      #   @param content [String] The text value of the quote.
+      #
+      #   @param align [Symbol, Courier::Models::Alignment, nil] Alignment of the quote.
+      #
+      #   @param border_color [String, nil] CSS border color property. For example, `#fff`
+      #
+      #   @param font_size [String, nil] CSS px font size for this quote block, e.g. `16px`. Overrides the size of the `t
+      #
+      #   @param line_height [String, nil] CSS line height for this quote block, as a px value or a unitless multiplier, e.
+      #
+      #   @param locales [Hash{Symbol=>Courier::Models::LocaleItem}, nil] Region specific content. See [locales docs](https://www.courier.com/docs/platfor
+      #
+      #   @param text_style [Symbol, Courier::Models::TextStyle]
+    end
+  end
+end

data/lib/courier/models/elemental_quote_node_with_type.rb

@@ -2,13 +2,15 @@
 
 module Courier
   module Models
-    class ElementalQuoteNodeWithType < Courier::Models::ElementalBaseNode
+    class ElementalQuoteNodeWithType < Courier::Models::ElementalQuoteNode
       # @!attribute type
       #
       #   @return [Symbol, Courier::Models::ElementalQuoteNodeWithType::Type, nil]
       optional :type, enum: -> { Courier::ElementalQuoteNodeWithType::Type }
 
       # @!method initialize(type: nil)
+      #   Renders a quote block.
+      #
       #   @param type [Symbol, Courier::Models::ElementalQuoteNodeWithType::Type]
 
       module Type