trycourier 4.9.0 → 4.10.0

data/lib/courier/resources/notifications.rb

@@ -3,9 +3,6 @@
 module Courier
   module Resources
     class Notifications
-      # @return [Courier::Resources::Notifications::Draft]
-      attr_reader :draft
-
       # @return [Courier::Resources::Notifications::Checks]
       attr_reader :checks
 
@@ -165,6 +162,111 @@ module Courier
         )
       end
 
+      # Replace the elemental content of a notification template. Overwrites all
+      # elements in the template with the provided content. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_content(id, content:, state: nil, request_options: {})
+      #
+      # @param id [String] Notification template ID (`nt_` prefix).
+      #
+      # @param content [Courier::Models::NotificationContentPutRequest::Content] Elemental content payload. The server defaults `version` when omitted.
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutContentParams
+      def put_content(id, params)
+        parsed, options = Courier::NotificationPutContentParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/content", id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Update a single element within a notification template. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_element(element_id, id:, type:, channels: nil, data: nil, if_: nil, loop_: nil, ref: nil, state: nil, request_options: {})
+      #
+      # @param element_id [String] Path param: Element ID within the template.
+      #
+      # @param id [String] Path param: Notification template ID (`nt_` prefix).
+      #
+      # @param type [String] Body param: Element type (text, meta, action, image, etc.).
+      #
+      # @param channels [Array<String>] Body param
+      #
+      # @param data [Hash{Symbol=>Object}] Body param
+      #
+      # @param if_ [String] Body param
+      #
+      # @param loop_ [String] Body param
+      #
+      # @param ref [String] Body param
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutElementParams
+      def put_element(element_id, params)
+        parsed, options = Courier::NotificationPutElementParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/elements/%2$s", id, element_id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Set locale-specific content overrides for a notification template. Each element
+      # override must reference an existing element by ID. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_locale(locale_id, id:, elements:, state: nil, request_options: {})
+      #
+      # @param locale_id [String] Path param: Locale code (e.g., `es`, `fr`, `pt-BR`).
+      #
+      # @param id [String] Path param: Notification template ID (`nt_` prefix).
+      #
+      # @param elements [Array<Courier::Models::NotificationLocalePutRequest::Element>] Body param: Elements with locale-specific content overrides.
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutLocaleParams
+      def put_locale(locale_id, params)
+        parsed, options = Courier::NotificationPutLocaleParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/locales/%2$s", id, locale_id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Courier::Models::NotificationReplaceParams} for more details.
       #
@@ -194,20 +296,34 @@ module Courier
         )
       end
 
-      # @overload retrieve_content(id, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::NotificationRetrieveContentParams} for more details.
+      #
+      # Retrieve the content of a notification template. The response shape depends on
+      # whether the template uses V1 (blocks/channels) or V2 (elemental) content. Use
+      # the `version` query parameter to select draft, published, or a specific
+      # historical version.
+      #
+      # @overload retrieve_content(id, version: nil, request_options: {})
+      #
+      # @param id [String] Notification template ID (`nt_` prefix).
+      #
+      # @param version [String] Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to `p
       #
-      # @param id [String]
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::NotificationGetContent]
+      # @return [Courier::Models::NotificationContentGetResponse, Courier::Models::NotificationGetContent]
       #
       # @see Courier::Models::NotificationRetrieveContentParams
       def retrieve_content(id, params = {})
+        parsed, options = Courier::NotificationRetrieveContentParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["notifications/%1$s/content", id],
-          model: Courier::NotificationGetContent,
-          options: params[:request_options]
+          query: query,
+          model: Courier::Models::NotificationRetrieveContentResponse,
+          options: options
         )
       end
 
@@ -216,7 +332,6 @@ module Courier
       # @param client [Courier::Client]
       def initialize(client:)
         @client = client
-        @draft = Courier::Resources::Notifications::Draft.new(client: client)
         @checks = Courier::Resources::Notifications::Checks.new(client: client)
       end
     end

data/lib/courier/resources/routing_strategies.rb

@@ -105,6 +105,34 @@ module Courier
         )
       end
 
+      # List notification templates associated with a routing strategy. Includes
+      # template metadata only, not full content.
+      #
+      # @overload list_notifications(id, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param id [String] Routing strategy ID (`rs_` prefix).
+      #
+      # @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      # @param limit [Integer] Maximum number of results per page. Default 20, max 100.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::AssociatedNotificationListResponse]
+      #
+      # @see Courier::Models::RoutingStrategyListNotificationsParams
+      def list_notifications(id, params = {})
+        parsed, options = Courier::RoutingStrategyListNotificationsParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["routing-strategies/%1$s/notifications", id],
+          query: query,
+          model: Courier::AssociatedNotificationListResponse,
+          options: options
+        )
+      end
+
       # Replace a routing strategy. Full document replacement; the caller must send the
       # complete desired state. Missing optional fields are cleared.
       #

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -62,6 +62,9 @@ require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/message_details"
 require_relative "courier/models/notification_template_create_request"
 require_relative "courier/models/notification_template_publish_request"
+require_relative "courier/models/notification_content_put_request"
+require_relative "courier/models/notification_element_put_request"
+require_relative "courier/models/notification_locale_put_request"
 require_relative "courier/models/notification_template_update_request"
 require_relative "courier/models/notification_template_payload"
 require_relative "courier/models/routing_strategy_create_request"
@@ -73,6 +76,7 @@ require_relative "courier/models/users/user_token"
 require_relative "courier/models/airship_profile"
 require_relative "courier/models/airship_profile_audience"
 require_relative "courier/models/alignment"
+require_relative "courier/models/associated_notification_list_response"
 require_relative "courier/models/audience"
 require_relative "courier/models/audience_delete_params"
 require_relative "courier/models/audience_filter"
@@ -137,6 +141,7 @@ require_relative "courier/models/elemental_meta_node_with_type"
 require_relative "courier/models/elemental_node"
 require_relative "courier/models/elemental_quote_node_with_type"
 require_relative "courier/models/elemental_text_node_with_type"
+require_relative "courier/models/element_with_checksums"
 require_relative "courier/models/email_footer"
 require_relative "courier/models/email_head"
 require_relative "courier/models/email_header"
@@ -190,6 +195,8 @@ require_relative "courier/models/ms_teams_base_properties"
 require_relative "courier/models/ms_teams_recipient"
 require_relative "courier/models/multiple_tokens"
 require_relative "courier/models/notification_archive_params"
+require_relative "courier/models/notification_content_get_response"
+require_relative "courier/models/notification_content_mutation_response"
 require_relative "courier/models/notification_create_params"
 require_relative "courier/models/notification_get_content"
 require_relative "courier/models/notification_list_params"
@@ -197,17 +204,21 @@ require_relative "courier/models/notification_list_response"
 require_relative "courier/models/notification_list_versions_params"
 require_relative "courier/models/notification_preference_details"
 require_relative "courier/models/notification_publish_params"
+require_relative "courier/models/notification_put_content_params"
+require_relative "courier/models/notification_put_element_params"
+require_relative "courier/models/notification_put_locale_params"
 require_relative "courier/models/notification_replace_params"
 require_relative "courier/models/notification_retrieve_content_params"
+require_relative "courier/models/notification_retrieve_content_response"
 require_relative "courier/models/notification_retrieve_params"
 require_relative "courier/models/notifications/check_delete_params"
 require_relative "courier/models/notifications/check_list_params"
 require_relative "courier/models/notifications/check_list_response"
 require_relative "courier/models/notifications/check_update_params"
 require_relative "courier/models/notifications/check_update_response"
-require_relative "courier/models/notifications/draft_retrieve_content_params"
 require_relative "courier/models/notification_template_get_response"
 require_relative "courier/models/notification_template_mutation_response"
+require_relative "courier/models/notification_template_state"
 require_relative "courier/models/notification_template_summary"
 require_relative "courier/models/notification_template_version_list_response"
 require_relative "courier/models/pagerduty"
@@ -247,6 +258,7 @@ require_relative "courier/models/request_archive_params"
 require_relative "courier/models/routing_strategy_archive_params"
 require_relative "courier/models/routing_strategy_create_params"
 require_relative "courier/models/routing_strategy_get_response"
+require_relative "courier/models/routing_strategy_list_notifications_params"
 require_relative "courier/models/routing_strategy_list_params"
 require_relative "courier/models/routing_strategy_list_response"
 require_relative "courier/models/routing_strategy_mutation_response"
@@ -343,7 +355,6 @@ require_relative "courier/resources/lists/subscriptions"
 require_relative "courier/resources/messages"
 require_relative "courier/resources/notifications"
 require_relative "courier/resources/notifications/checks"
-require_relative "courier/resources/notifications/draft"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
 require_relative "courier/resources/providers"

data/rbi/courier/models/associated_notification_list_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class AssociatedNotificationListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::AssociatedNotificationListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::NotificationTemplateSummary]) }
+      attr_accessor :results
+
+      # Paginated list of notification templates associated with a routing strategy.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::NotificationTemplateSummary::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          {
+            paging: Courier::Paging,
+            results: T::Array[Courier::NotificationTemplateSummary]
+          }
+        )
+      end
+      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/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