trycourier 4.9.0 → 4.10.1

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

data/rbi/courier/models/notification_content_put_request.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationContentPutRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationContentPutRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Elemental content payload. The server defaults `version` when omitted.
+      sig { returns(Courier::NotificationContentPutRequest::Content) }
+      attr_reader :content
+
+      sig do
+        params(
+          content: Courier::NotificationContentPutRequest::Content::OrHash
+        ).void
+      end
+      attr_writer :content
+
+      # Template state. Defaults to `DRAFT`.
+      sig { returns(T.nilable(Courier::NotificationTemplateState::OrSymbol)) }
+      attr_reader :state
+
+      sig { params(state: Courier::NotificationTemplateState::OrSymbol).void }
+      attr_writer :state
+
+      # Request body for replacing the elemental content of a notification template.
+      sig do
+        params(
+          content: Courier::NotificationContentPutRequest::Content::OrHash,
+          state: Courier::NotificationTemplateState::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Elemental content payload. The server defaults `version` when omitted.
+        content:,
+        # Template state. Defaults to `DRAFT`.
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: Courier::NotificationContentPutRequest::Content,
+            state: Courier::NotificationTemplateState::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Content < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationContentPutRequest::Content,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                Courier::ElementalTextNodeWithType,
+                Courier::ElementalMetaNodeWithType,
+                Courier::ElementalChannelNodeWithType,
+                Courier::ElementalImageNodeWithType,
+                Courier::ElementalActionNodeWithType,
+                Courier::ElementalDividerNodeWithType,
+                Courier::ElementalQuoteNodeWithType,
+                Courier::ElementalHTMLNodeWithType
+              )
+            ]
+          )
+        end
+        attr_accessor :elements
+
+        # Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+        # omitted.
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Elemental content payload. The server defaults `version` when omitted.
+        sig do
+          params(
+            elements:
+              T::Array[
+                T.any(
+                  Courier::ElementalTextNodeWithType::OrHash,
+                  Courier::ElementalMetaNodeWithType::OrHash,
+                  Courier::ElementalChannelNodeWithType::OrHash,
+                  Courier::ElementalImageNodeWithType::OrHash,
+                  Courier::ElementalActionNodeWithType::OrHash,
+                  Courier::ElementalDividerNodeWithType::OrHash,
+                  Courier::ElementalQuoteNodeWithType::OrHash,
+                  Courier::ElementalHTMLNodeWithType::OrHash
+                )
+              ],
+            version: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          elements:,
+          # Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+          # omitted.
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              elements:
+                T::Array[
+                  T.any(
+                    Courier::ElementalTextNodeWithType,
+                    Courier::ElementalMetaNodeWithType,
+                    Courier::ElementalChannelNodeWithType,
+                    Courier::ElementalImageNodeWithType,
+                    Courier::ElementalActionNodeWithType,
+                    Courier::ElementalDividerNodeWithType,
+                    Courier::ElementalQuoteNodeWithType,
+                    Courier::ElementalHTMLNodeWithType
+                  )
+                ],
+              version: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_element_put_request.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationElementPutRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationElementPutRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Element type (text, meta, action, image, etc.).
+      sig { returns(String) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :channels
+
+      sig { params(channels: T::Array[String]).void }
+      attr_writer :channels
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :data
+
+      sig { params(data: T::Hash[Symbol, T.anything]).void }
+      attr_writer :data
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :if_
+
+      sig { params(if_: String).void }
+      attr_writer :if_
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :loop_
+
+      sig { params(loop_: String).void }
+      attr_writer :loop_
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :ref
+
+      sig { params(ref: String).void }
+      attr_writer :ref
+
+      # Template state. Defaults to `DRAFT`.
+      sig { returns(T.nilable(Courier::NotificationTemplateState::OrSymbol)) }
+      attr_reader :state
+
+      sig { params(state: Courier::NotificationTemplateState::OrSymbol).void }
+      attr_writer :state
+
+      # Request body for updating a single element. Additional type-specific fields are
+      # allowed.
+      sig do
+        params(
+          type: String,
+          channels: T::Array[String],
+          data: T::Hash[Symbol, T.anything],
+          if_: String,
+          loop_: String,
+          ref: String,
+          state: Courier::NotificationTemplateState::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Element type (text, meta, action, image, etc.).
+        type:,
+        channels: nil,
+        data: nil,
+        if_: nil,
+        loop_: nil,
+        ref: nil,
+        # Template state. Defaults to `DRAFT`.
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            type: String,
+            channels: T::Array[String],
+            data: T::Hash[Symbol, T.anything],
+            if_: String,
+            loop_: String,
+            ref: String,
+            state: Courier::NotificationTemplateState::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_locale_put_request.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationLocalePutRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationLocalePutRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Elements with locale-specific content overrides.
+      sig { returns(T::Array[Courier::NotificationLocalePutRequest::Element]) }
+      attr_accessor :elements
+
+      # Template state. Defaults to `DRAFT`.
+      sig { returns(T.nilable(Courier::NotificationTemplateState::OrSymbol)) }
+      attr_reader :state
+
+      sig { params(state: Courier::NotificationTemplateState::OrSymbol).void }
+      attr_writer :state
+
+      # Request body for setting locale-specific content overrides. Each element
+      # override must include the target element ID.
+      sig do
+        params(
+          elements:
+            T::Array[Courier::NotificationLocalePutRequest::Element::OrHash],
+          state: Courier::NotificationTemplateState::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Elements with locale-specific content overrides.
+        elements:,
+        # Template state. Defaults to `DRAFT`.
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            elements: T::Array[Courier::NotificationLocalePutRequest::Element],
+            state: Courier::NotificationTemplateState::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Element < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::NotificationLocalePutRequest::Element,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # Target element ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # Target element ID.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_put_content_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationPutContentParams,
+            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_put_element_params.rbi

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

data/rbi/courier/models/notification_put_locale_params.rbi

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

data/rbi/courier/models/notification_retrieve_content_params.rbi

@@ -17,18 +17,37 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
+      # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+      # `published`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
       sig do
         params(
           id: String,
+          version: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        id:,
+        # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+        # `published`.
+        version: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Courier::RequestOptions }
+          {
+            id: String,
+            version: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/notification_retrieve_content_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Elemental content response for V2 templates. Contains versioned elements with
+    # content checksums.
+    module NotificationRetrieveContentResponse
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::NotificationContentGetResponse,
+            Courier::NotificationGetContent
+          )
+        end
+
+      sig do
+        override.returns(
+          T::Array[
+            Courier::Models::NotificationRetrieveContentResponse::Variants
+          ]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_state.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Template state. Defaults to `DRAFT`.
+    module NotificationTemplateState
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Courier::NotificationTemplateState) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DRAFT = T.let(:DRAFT, Courier::NotificationTemplateState::TaggedSymbol)
+      PUBLISHED =
+        T.let(:PUBLISHED, Courier::NotificationTemplateState::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Courier::NotificationTemplateState::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/provider_update_params.rbi

@@ -14,7 +14,8 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
-      # The provider key identifying the type.
+      # The provider key identifying the type. Required on every request because it
+      # selects the provider-specific settings schema for validation.
       sig { returns(String) }
       attr_accessor :provider
 
@@ -53,7 +54,8 @@ module Courier
       end
       def self.new(
         id:,
-        # The provider key identifying the type.
+        # The provider key identifying the type. Required on every request because it
+        # selects the provider-specific settings schema for validation.
         provider:,
         # Updated alias. Omit to clear.
         alias_: nil,