trycourier 4.9.0 → 4.10.1

data/rbi/courier/models/routing_strategy_list_notifications_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Courier
+  module Models
+    class RoutingStrategyListNotificationsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::RoutingStrategyListNotificationsParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Opaque pagination cursor from a previous response. Omit for the first page.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      # Maximum number of results per page. Default 20, max 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          id: String,
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of results per page. Default 20, max 100.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cursor: T.nilable(String),
+            limit: Integer,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -7,6 +7,9 @@ module Courier
 
   Alignment = Courier::Models::Alignment
 
+  AssociatedNotificationListResponse =
+    Courier::Models::AssociatedNotificationListResponse
+
   Audience = Courier::Models::Audience
 
   AudienceDeleteParams = Courier::Models::AudienceDeleteParams
@@ -126,6 +129,8 @@ module Courier
 
   ElementalTextNodeWithType = Courier::Models::ElementalTextNodeWithType
 
+  ElementWithChecksums = Courier::Models::ElementWithChecksums
+
   EmailFooter = Courier::Models::EmailFooter
 
   EmailHead = Courier::Models::EmailHead
@@ -218,8 +223,18 @@ module Courier
 
   NotificationArchiveParams = Courier::Models::NotificationArchiveParams
 
+  NotificationContentGetResponse =
+    Courier::Models::NotificationContentGetResponse
+
+  NotificationContentMutationResponse =
+    Courier::Models::NotificationContentMutationResponse
+
+  NotificationContentPutRequest = Courier::Models::NotificationContentPutRequest
+
   NotificationCreateParams = Courier::Models::NotificationCreateParams
 
+  NotificationElementPutRequest = Courier::Models::NotificationElementPutRequest
+
   NotificationGetContent = Courier::Models::NotificationGetContent
 
   NotificationListParams = Courier::Models::NotificationListParams
@@ -227,10 +242,18 @@ module Courier
   NotificationListVersionsParams =
     Courier::Models::NotificationListVersionsParams
 
+  NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
   NotificationPublishParams = Courier::Models::NotificationPublishParams
 
+  NotificationPutContentParams = Courier::Models::NotificationPutContentParams
+
+  NotificationPutElementParams = Courier::Models::NotificationPutElementParams
+
+  NotificationPutLocaleParams = Courier::Models::NotificationPutLocaleParams
+
   NotificationReplaceParams = Courier::Models::NotificationReplaceParams
 
   NotificationRetrieveContentParams =
@@ -246,14 +269,13 @@ module Courier
   NotificationTemplateGetResponse =
     Courier::Models::NotificationTemplateGetResponse
 
-  NotificationTemplateMutationResponse =
-    Courier::Models::NotificationTemplateMutationResponse
-
   NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
 
   NotificationTemplatePublishRequest =
     Courier::Models::NotificationTemplatePublishRequest
 
+  NotificationTemplateState = Courier::Models::NotificationTemplateState
+
   NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
 
   NotificationTemplateUpdateRequest =
@@ -324,13 +346,13 @@ module Courier
 
   RoutingStrategyGetResponse = Courier::Models::RoutingStrategyGetResponse
 
+  RoutingStrategyListNotificationsParams =
+    Courier::Models::RoutingStrategyListNotificationsParams
+
   RoutingStrategyListParams = Courier::Models::RoutingStrategyListParams
 
   RoutingStrategyListResponse = Courier::Models::RoutingStrategyListResponse
 
-  RoutingStrategyMutationResponse =
-    Courier::Models::RoutingStrategyMutationResponse
-
   RoutingStrategyReplaceParams = Courier::Models::RoutingStrategyReplaceParams
 
   RoutingStrategyReplaceRequest = Courier::Models::RoutingStrategyReplaceRequest

data/rbi/courier/resources/notifications.rbi

@@ -3,9 +3,6 @@
 module Courier
   module Resources
     class Notifications
-      sig { returns(Courier::Resources::Notifications::Draft) }
-      attr_reader :draft
-
       sig { returns(Courier::Resources::Notifications::Checks) }
       attr_reader :checks
 
@@ -16,7 +13,7 @@ module Courier
           notification: Courier::NotificationTemplatePayload::OrHash,
           state: Courier::NotificationTemplateCreateRequest::State::OrSymbol,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationTemplateMutationResponse)
+        ).returns(Courier::NotificationTemplateGetResponse)
       end
       def create(
         # Full document shape used in POST and PUT request bodies, and returned inside the
@@ -120,6 +117,93 @@ 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.
+      sig do
+        params(
+          id: String,
+          content: Courier::NotificationContentPutRequest::Content::OrHash,
+          state: Courier::NotificationTemplateState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationContentMutationResponse)
+      end
+      def put_content(
+        # Notification template ID (`nt_` prefix).
+        id,
+        # Elemental content payload. The server defaults `version` when omitted.
+        content:,
+        # Template state. Defaults to `DRAFT`.
+        state: nil,
+        request_options: {}
+      )
+      end
+
+      # Update a single element within a notification template. Only supported for V2
+      # (elemental) templates.
+      sig do
+        params(
+          element_id: String,
+          id: String,
+          type: String,
+          channels: T::Array[String],
+          data: T::Hash[Symbol, T.anything],
+          if_: String,
+          loop_: String,
+          ref: String,
+          state: Courier::NotificationTemplateState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationContentMutationResponse)
+      end
+      def put_element(
+        # Path param: Element ID within the template.
+        element_id,
+        # Path param: Notification template ID (`nt_` prefix).
+        id:,
+        # Body param: Element type (text, meta, action, image, etc.).
+        type:,
+        # Body param
+        channels: nil,
+        # Body param
+        data: nil,
+        # Body param
+        if_: nil,
+        # Body param
+        loop_: nil,
+        # Body param
+        ref: nil,
+        # Body param: Template state. Defaults to `DRAFT`.
+        state: nil,
+        request_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.
+      sig do
+        params(
+          locale_id: String,
+          id: String,
+          elements:
+            T::Array[Courier::NotificationLocalePutRequest::Element::OrHash],
+          state: Courier::NotificationTemplateState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationContentMutationResponse)
+      end
+      def put_locale(
+        # Path param: Locale code (e.g., `es`, `fr`, `pt-BR`).
+        locale_id,
+        # Path param: Notification template ID (`nt_` prefix).
+        id:,
+        # Body param: Elements with locale-specific content overrides.
+        elements:,
+        # Body param: Template state. Defaults to `DRAFT`.
+        state: nil,
+        request_options: {}
+      )
+      end
+
       # Replace a notification template. All fields are required.
       sig do
         params(
@@ -127,7 +211,7 @@ module Courier
           notification: Courier::NotificationTemplatePayload::OrHash,
           state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationTemplateMutationResponse)
+        ).returns(Courier::NotificationTemplateGetResponse)
       end
       def replace(
         # Template ID (nt\_ prefix).
@@ -142,13 +226,27 @@ module Courier
       )
       end
 
+      # 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.
       sig do
         params(
           id: String,
+          version: String,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::NotificationGetContent)
+        ).returns(
+          Courier::Models::NotificationRetrieveContentResponse::Variants
+        )
       end
-      def retrieve_content(id, request_options: {})
+      def retrieve_content(
+        # Notification template ID (`nt_` prefix).
+        id,
+        # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+        # `published`.
+        version: nil,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/courier/resources/providers.rbi

@@ -47,9 +47,11 @@ module Courier
       )
       end
 
-      # Update an existing provider configuration. The `provider` key is required. All
-      # other fields are optional — omitted fields are cleared from the stored
-      # configuration (this is a full replacement, not a partial merge).
+      # Replace an existing provider configuration. The `provider` key is required and
+      # determines which provider-specific settings schema is applied. All other fields
+      # are optional — omitted fields are cleared from the stored configuration (this is
+      # a full replacement, not a partial merge). Changing the provider type for an
+      # existing configuration is not supported.
       sig do
         params(
           id: String,
@@ -63,7 +65,8 @@ module Courier
       def update(
         # A unique identifier of the provider configuration to update.
         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,

data/rbi/courier/resources/routing_strategies.rbi

@@ -15,7 +15,7 @@ module Courier
             T.nilable(T::Hash[Symbol, Courier::MessageProvidersType::OrHash]),
           tags: T.nilable(T::Array[String]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::RoutingStrategyMutationResponse)
+        ).returns(Courier::RoutingStrategyGetResponse)
       end
       def create(
         # Human-readable name for the routing strategy.
@@ -83,6 +83,27 @@ module Courier
       )
       end
 
+      # List notification templates associated with a routing strategy. Includes
+      # template metadata only, not full content.
+      sig do
+        params(
+          id: String,
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::AssociatedNotificationListResponse)
+      end
+      def list_notifications(
+        # Routing strategy ID (`rs_` prefix).
+        id,
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of results per page. Default 20, max 100.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
       # Replace a routing strategy. Full document replacement; the caller must send the
       # complete desired state. Missing optional fields are cleared.
       sig do
@@ -96,7 +117,7 @@ module Courier
             T.nilable(T::Hash[Symbol, Courier::MessageProvidersType::OrHash]),
           tags: T.nilable(T::Array[String]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::RoutingStrategyMutationResponse)
+        ).returns(Courier::RoutingStrategyGetResponse)
       end
       def replace(
         # Routing strategy ID (rs\_ prefix).

data/sig/courier/models/associated_notification_list_response.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type associated_notification_list_response =
+      {
+        paging: Courier::Paging,
+        results: ::Array[Courier::NotificationTemplateSummary]
+      }
+
+    class AssociatedNotificationListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor paging: Courier::Paging
+
+      attr_accessor results: ::Array[Courier::NotificationTemplateSummary]
+
+      def initialize: (
+        paging: Courier::Paging,
+        results: ::Array[Courier::NotificationTemplateSummary]
+      ) -> void
+
+      def to_hash: -> {
+        paging: Courier::Paging,
+        results: ::Array[Courier::NotificationTemplateSummary]
+      }
+    end
+  end
+end

data/sig/courier/models/element_with_checksums.rbs

@@ -0,0 +1,60 @@
+module Courier
+  module Models
+    type element_with_checksums =
+      {
+        checksum: String,
+        type: String,
+        id: String,
+        elements: ::Array[Courier::ElementWithChecksums],
+        locales: ::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+      }
+
+    class ElementWithChecksums < Courier::Internal::Type::BaseModel
+      attr_accessor checksum: String
+
+      attr_accessor type: String
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader elements: ::Array[Courier::ElementWithChecksums]?
+
+      def elements=: (
+        ::Array[Courier::ElementWithChecksums]
+      ) -> ::Array[Courier::ElementWithChecksums]
+
+      attr_reader locales: ::Hash[Symbol, Courier::ElementWithChecksums::Locale]?
+
+      def locales=: (
+        ::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+      ) -> ::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+
+      def initialize: (
+        checksum: String,
+        type: String,
+        ?id: String,
+        ?elements: ::Array[Courier::ElementWithChecksums],
+        ?locales: ::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+      ) -> void
+
+      def to_hash: -> {
+        checksum: String,
+        type: String,
+        id: String,
+        elements: ::Array[Courier::ElementWithChecksums],
+        locales: ::Hash[Symbol, Courier::ElementWithChecksums::Locale]
+      }
+
+      type locale = { checksum: String }
+
+      class Locale < Courier::Internal::Type::BaseModel
+        attr_accessor checksum: String
+
+        def initialize: (checksum: String) -> void
+
+        def to_hash: -> { checksum: String }
+      end
+    end
+  end
+end

data/sig/courier/models/notification_content_get_response.rbs

@@ -0,0 +1,22 @@
+module Courier
+  module Models
+    type notification_content_get_response =
+      { elements: ::Array[Courier::ElementWithChecksums], version: String }
+
+    class NotificationContentGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor elements: ::Array[Courier::ElementWithChecksums]
+
+      attr_accessor version: String
+
+      def initialize: (
+        elements: ::Array[Courier::ElementWithChecksums],
+        version: String
+      ) -> void
+
+      def to_hash: -> {
+        elements: ::Array[Courier::ElementWithChecksums],
+        version: String
+      }
+    end
+  end
+end

data/sig/courier/models/notification_content_mutation_response.rbs

@@ -0,0 +1,47 @@
+module Courier
+  module Models
+    type notification_content_mutation_response =
+      {
+        id: String,
+        elements: ::Array[Courier::NotificationContentMutationResponse::Element],
+        state: Courier::Models::notification_template_state,
+        version: String
+      }
+
+    class NotificationContentMutationResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor elements: ::Array[Courier::NotificationContentMutationResponse::Element]
+
+      attr_accessor state: Courier::Models::notification_template_state
+
+      attr_accessor version: String
+
+      def initialize: (
+        id: String,
+        elements: ::Array[Courier::NotificationContentMutationResponse::Element],
+        state: Courier::Models::notification_template_state,
+        version: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        elements: ::Array[Courier::NotificationContentMutationResponse::Element],
+        state: Courier::Models::notification_template_state,
+        version: String
+      }
+
+      type element = { id: String, checksum: String }
+
+      class Element < Courier::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor checksum: String
+
+        def initialize: (id: String, checksum: String) -> void
+
+        def to_hash: -> { id: String, checksum: String }
+      end
+    end
+  end
+end

data/sig/courier/models/notification_content_put_request.rbs

@@ -0,0 +1,50 @@
+module Courier
+  module Models
+    type notification_content_put_request =
+      {
+        content: Courier::NotificationContentPutRequest::Content,
+        state: Courier::Models::notification_template_state
+      }
+
+    class NotificationContentPutRequest < Courier::Internal::Type::BaseModel
+      attr_accessor content: Courier::NotificationContentPutRequest::Content
+
+      attr_reader state: Courier::Models::notification_template_state?
+
+      def state=: (
+        Courier::Models::notification_template_state
+      ) -> Courier::Models::notification_template_state
+
+      def initialize: (
+        content: Courier::NotificationContentPutRequest::Content,
+        ?state: Courier::Models::notification_template_state
+      ) -> void
+
+      def to_hash: -> {
+        content: Courier::NotificationContentPutRequest::Content,
+        state: Courier::Models::notification_template_state
+      }
+
+      type content =
+        { elements: ::Array[Courier::Models::elemental_node], version: String }
+
+      class Content < Courier::Internal::Type::BaseModel
+        attr_accessor elements: ::Array[Courier::Models::elemental_node]
+
+        attr_reader version: String?
+
+        def version=: (String) -> String
+
+        def initialize: (
+          elements: ::Array[Courier::Models::elemental_node],
+          ?version: String
+        ) -> void
+
+        def to_hash: -> {
+          elements: ::Array[Courier::Models::elemental_node],
+          version: String
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/notification_element_put_request.rbs

@@ -0,0 +1,64 @@
+module Courier
+  module Models
+    type notification_element_put_request =
+      {
+        type: String,
+        channels: ::Array[String],
+        data: ::Hash[Symbol, top],
+        if_: String,
+        loop_: String,
+        ref: String,
+        state: Courier::Models::notification_template_state
+      }
+
+    class NotificationElementPutRequest < Courier::Internal::Type::BaseModel
+      attr_accessor type: String
+
+      attr_reader channels: ::Array[String]?
+
+      def channels=: (::Array[String]) -> ::Array[String]
+
+      attr_reader data: ::Hash[Symbol, top]?
+
+      def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader if_: String?
+
+      def if_=: (String) -> String
+
+      attr_reader loop_: String?
+
+      def loop_=: (String) -> String
+
+      attr_reader ref: String?
+
+      def ref=: (String) -> String
+
+      attr_reader state: Courier::Models::notification_template_state?
+
+      def state=: (
+        Courier::Models::notification_template_state
+      ) -> Courier::Models::notification_template_state
+
+      def initialize: (
+        type: String,
+        ?channels: ::Array[String],
+        ?data: ::Hash[Symbol, top],
+        ?if_: String,
+        ?loop_: String,
+        ?ref: String,
+        ?state: Courier::Models::notification_template_state
+      ) -> void
+
+      def to_hash: -> {
+        type: String,
+        channels: ::Array[String],
+        data: ::Hash[Symbol, top],
+        if_: String,
+        loop_: String,
+        ref: String,
+        state: Courier::Models::notification_template_state
+      }
+    end
+  end
+end

data/sig/courier/models/notification_locale_put_request.rbs

@@ -0,0 +1,39 @@
+module Courier
+  module Models
+    type notification_locale_put_request =
+      {
+        elements: ::Array[Courier::NotificationLocalePutRequest::Element],
+        state: Courier::Models::notification_template_state
+      }
+
+    class NotificationLocalePutRequest < Courier::Internal::Type::BaseModel
+      attr_accessor elements: ::Array[Courier::NotificationLocalePutRequest::Element]
+
+      attr_reader state: Courier::Models::notification_template_state?
+
+      def state=: (
+        Courier::Models::notification_template_state
+      ) -> Courier::Models::notification_template_state
+
+      def initialize: (
+        elements: ::Array[Courier::NotificationLocalePutRequest::Element],
+        ?state: Courier::Models::notification_template_state
+      ) -> void
+
+      def to_hash: -> {
+        elements: ::Array[Courier::NotificationLocalePutRequest::Element],
+        state: Courier::Models::notification_template_state
+      }
+
+      type element = { id: String }
+
+      class Element < Courier::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
+      end
+    end
+  end
+end