trycourier 4.8.0 → 4.10.0

data/rbi/courier/models/channel.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Channel < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Channel, Courier::Internal::AnyHash) }
+
+      # Brand id used for rendering.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::ChannelMetadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::ChannelMetadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Channel specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      # Providers enabled for this channel.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :providers
+
+      # Defaults to `single`.
+      sig { returns(T.nilable(Courier::Channel::RoutingMethod::OrSymbol)) }
+      attr_accessor :routing_method
+
+      sig { returns(T.nilable(Courier::Timeouts)) }
+      attr_reader :timeouts
+
+      sig { params(timeouts: T.nilable(Courier::Timeouts::OrHash)).void }
+      attr_writer :timeouts
+
+      sig do
+        params(
+          brand_id: T.nilable(String),
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::ChannelMetadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          providers: T.nilable(T::Array[String]),
+          routing_method: T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+          timeouts: T.nilable(Courier::Timeouts::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand id used for rendering.
+        brand_id: nil,
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Channel specific overrides.
+        override: nil,
+        # Providers enabled for this channel.
+        providers: nil,
+        # Defaults to `single`.
+        routing_method: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_id: T.nilable(String),
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::ChannelMetadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            providers: T.nilable(T::Array[String]),
+            routing_method:
+              T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+            timeouts: T.nilable(Courier::Timeouts)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Defaults to `single`.
+      module RoutingMethod
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Channel::RoutingMethod) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALL = T.let(:all, Courier::Channel::RoutingMethod::TaggedSymbol)
+        SINGLE = T.let(:single, Courier::Channel::RoutingMethod::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::Channel::RoutingMethod::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/channel_metadata.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ChannelMetadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ChannelMetadata, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/element_with_checksums.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementWithChecksums < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementWithChecksums, Courier::Internal::AnyHash)
+        end
+
+      # MD5 hash of translatable content.
+      sig { returns(String) }
+      attr_accessor :checksum
+
+      # Element type (text, meta, action, etc.).
+      sig { returns(String) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Nested child elements (for group-type elements).
+      sig { returns(T.nilable(T::Array[Courier::ElementWithChecksums])) }
+      attr_reader :elements
+
+      sig { params(elements: T::Array[Courier::ElementWithChecksums]).void }
+      attr_writer :elements
+
+      # Locale-specific content with checksums.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Courier::ElementWithChecksums::Locale])
+        )
+      end
+      attr_reader :locales
+
+      sig do
+        params(
+          locales:
+            T::Hash[Symbol, Courier::ElementWithChecksums::Locale::OrHash]
+        ).void
+      end
+      attr_writer :locales
+
+      # An element with its content checksum and optional nested elements and locale
+      # checksums.
+      sig do
+        params(
+          checksum: String,
+          type: String,
+          id: String,
+          elements: T::Array[Courier::ElementWithChecksums],
+          locales:
+            T::Hash[Symbol, Courier::ElementWithChecksums::Locale::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # MD5 hash of translatable content.
+        checksum:,
+        # Element type (text, meta, action, etc.).
+        type:,
+        id: nil,
+        # Nested child elements (for group-type elements).
+        elements: nil,
+        # Locale-specific content with checksums.
+        locales: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            checksum: String,
+            type: String,
+            id: String,
+            elements: T::Array[Courier::ElementWithChecksums],
+            locales: T::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Locale < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::ElementWithChecksums::Locale,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :checksum
+
+        sig { params(checksum: String).returns(T.attached_class) }
+        def self.new(checksum:)
+        end
+
+        sig { override.returns({ checksum: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_content.rbi

@@ -18,7 +18,8 @@ module Courier
               Courier::ElementalImageNodeWithType,
               Courier::ElementalActionNodeWithType,
               Courier::ElementalDividerNodeWithType,
-              Courier::ElementalQuoteNodeWithType
+              Courier::ElementalQuoteNodeWithType,
+              Courier::ElementalHTMLNodeWithType
             )
           ]
         )
@@ -40,7 +41,8 @@ module Courier
                 Courier::ElementalImageNodeWithType::OrHash,
                 Courier::ElementalActionNodeWithType::OrHash,
                 Courier::ElementalDividerNodeWithType::OrHash,
-                Courier::ElementalQuoteNodeWithType::OrHash
+                Courier::ElementalQuoteNodeWithType::OrHash,
+                Courier::ElementalHTMLNodeWithType::OrHash
               )
             ],
           version: String
@@ -65,7 +67,8 @@ module Courier
                   Courier::ElementalImageNodeWithType,
                   Courier::ElementalActionNodeWithType,
                   Courier::ElementalDividerNodeWithType,
-                  Courier::ElementalQuoteNodeWithType
+                  Courier::ElementalQuoteNodeWithType,
+                  Courier::ElementalHTMLNodeWithType
                 )
               ],
             version: String

data/rbi/courier/models/elemental_html_node_with_type.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalHTMLNodeWithType < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalHTMLNodeWithType, Courier::Internal::AnyHash)
+        end
+
+      sig do
+        returns(T.nilable(Courier::ElementalHTMLNodeWithType::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(type: nil)
+      end
+
+      sig do
+        override.returns(
+          { type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol }
+        )
+      end
+      def to_hash
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::ElementalHTMLNodeWithType::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML =
+          T.let(:html, Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_node.rbi

@@ -24,7 +24,8 @@ module Courier
             Courier::ElementalImageNodeWithType,
             Courier::ElementalActionNodeWithType,
             Courier::ElementalDividerNodeWithType,
-            Courier::ElementalQuoteNodeWithType
+            Courier::ElementalQuoteNodeWithType,
+            Courier::ElementalHTMLNodeWithType
           )
         end
 

data/rbi/courier/models/message_channels.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageChannels =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::Channel],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_providers.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageProviders =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::MessageProvidersType],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_providers_type.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Courier
+  module Models
+    class MessageProvidersType < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::MessageProvidersType, Courier::Internal::AnyHash)
+        end
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::Metadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::Metadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Provider-specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :timeouts
+
+      sig do
+        params(
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::Metadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          timeouts: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Provider-specific overrides.
+        override: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::Metadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            timeouts: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/metadata.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Metadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Metadata, Courier::Internal::AnyHash) }
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_archive_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::NotificationArchiveParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Courier::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_content_get_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationContentGetResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationContentGetResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Courier::ElementWithChecksums]) }
+      attr_accessor :elements
+
+      # Content version identifier.
+      sig { returns(String) }
+      attr_accessor :version
+
+      # Elemental content response for V2 templates. Contains versioned elements with
+      # content checksums.
+      sig do
+        params(
+          elements: T::Array[Courier::ElementWithChecksums::OrHash],
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        elements:,
+        # Content version identifier.
+        version:
+      )
+      end
+
+      sig do
+        override.returns(
+          { elements: T::Array[Courier::ElementWithChecksums], version: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_content_mutation_response.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationContentMutationResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationContentMutationResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Template ID.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        returns(T::Array[Courier::NotificationContentMutationResponse::Element])
+      end
+      attr_accessor :elements
+
+      # Template state. Defaults to `DRAFT`.
+      sig { returns(Courier::NotificationTemplateState::TaggedSymbol) }
+      attr_accessor :state
+
+      # Content version identifier.
+      sig { returns(String) }
+      attr_accessor :version
+
+      # Shared mutation response for `PUT` content, `PUT` element, and `PUT` locale
+      # operations. Contains the template ID, content version, per-element checksums,
+      # and resulting state.
+      sig do
+        params(
+          id: String,
+          elements:
+            T::Array[
+              Courier::NotificationContentMutationResponse::Element::OrHash
+            ],
+          state: Courier::NotificationTemplateState::OrSymbol,
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template ID.
+        id:,
+        elements:,
+        # Template state. Defaults to `DRAFT`.
+        state:,
+        # Content version identifier.
+        version:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            elements:
+              T::Array[Courier::NotificationContentMutationResponse::Element],
+            state: Courier::NotificationTemplateState::TaggedSymbol,
+            version: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Element < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationContentMutationResponse::Element,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :checksum
+
+        sig { params(id: String, checksum: String).returns(T.attached_class) }
+        def self.new(id:, checksum:)
+        end
+
+        sig { override.returns({ id: String, checksum: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end