trycourier 4.15.0 → 4.17.0

data/rbi/courier/models.rbi

@@ -381,8 +381,44 @@ module Courier
 
   Preference = Courier::Models::Preference
 
+  PreferenceSectionArchiveParams =
+    Courier::Models::PreferenceSectionArchiveParams
+
+  PreferenceSectionCreateParams = Courier::Models::PreferenceSectionCreateParams
+
+  PreferenceSectionCreateRequest =
+    Courier::Models::PreferenceSectionCreateRequest
+
+  PreferenceSectionGetResponse = Courier::Models::PreferenceSectionGetResponse
+
+  PreferenceSectionListParams = Courier::Models::PreferenceSectionListParams
+
+  PreferenceSectionListResponse = Courier::Models::PreferenceSectionListResponse
+
+  PreferenceSectionPublishParams =
+    Courier::Models::PreferenceSectionPublishParams
+
+  PreferenceSectionReplaceParams =
+    Courier::Models::PreferenceSectionReplaceParams
+
+  PreferenceSectionReplaceRequest =
+    Courier::Models::PreferenceSectionReplaceRequest
+
+  PreferenceSectionRetrieveParams =
+    Courier::Models::PreferenceSectionRetrieveParams
+
+  PreferenceSections = Courier::Models::PreferenceSections
+
   PreferenceStatus = Courier::Models::PreferenceStatus
 
+  PreferenceTopicCreateRequest = Courier::Models::PreferenceTopicCreateRequest
+
+  PreferenceTopicGetResponse = Courier::Models::PreferenceTopicGetResponse
+
+  PreferenceTopicListResponse = Courier::Models::PreferenceTopicListResponse
+
+  PreferenceTopicReplaceRequest = Courier::Models::PreferenceTopicReplaceRequest
+
   ProfileCreateParams = Courier::Models::ProfileCreateParams
 
   ProfileDeleteParams = Courier::Models::ProfileDeleteParams
@@ -411,6 +447,8 @@ module Courier
 
   ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
+
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest

data/rbi/courier/resources/journeys/templates.rbi

@@ -126,6 +126,59 @@ module Courier
         )
         end
 
+        # Replace the elemental content of a journey-scoped notification template.
+        # Overwrites all elements in the template draft with the provided content.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            content: Courier::NotificationContentPutRequest::Content::OrHash,
+            state: Courier::NotificationTemplateState::OrSymbol,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::NotificationContentMutationResponse)
+        end
+        def put_content(
+          # Path param: Notification template id
+          notification_id,
+          # Path param: Journey id
+          template_id:,
+          # Body param: Elemental content payload. The server defaults `version` when
+          # omitted.
+          content:,
+          # Body param: Template state. Defaults to `DRAFT`.
+          state: nil,
+          request_options: {}
+        )
+        end
+
+        # Set locale-specific content overrides for a journey-scoped notification
+        # template. Each element override must reference an existing element by ID.
+        sig do
+          params(
+            locale_id: String,
+            template_id: String,
+            notification_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: Journey id
+          template_id:,
+          # Path param: Notification template id
+          notification_id:,
+          # Body param: Elements with locale-specific content overrides.
+          elements:,
+          # Body param: Template state. Defaults to `DRAFT`.
+          state: nil,
+          request_options: {}
+        )
+        end
+
         # Replace the journey-scoped notification template draft.
         sig do
           params(
@@ -150,6 +203,31 @@ module Courier
         )
         end
 
+        # Retrieve the elemental content of a journey-scoped notification template. The
+        # response contains the versioned elements along with their content checksums,
+        # which can be used to detect changes between versions. Pass `?version=draft`
+        # (default `published`) to retrieve the working draft, or `?version=vN` for a
+        # historical version.
+        sig do
+          params(
+            notification_id: String,
+            template_id: String,
+            version: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::NotificationContentGetResponse)
+        end
+        def retrieve_content(
+          # Path param: Notification template id
+          notification_id,
+          # Path param: Journey id
+          template_id:,
+          # Query param: Accepts `draft`, `published`, or a version string (e.g., `v001`).
+          # Defaults to `published`.
+          version: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Courier::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/courier/resources/preference_sections/topics.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class PreferenceSections
+      class Topics
+        # Create a subscription preference topic inside a section. Fails with 404 if the
+        # section does not exist. The topic id is generated and returned.
+        sig do
+          params(
+            section_id: String,
+            default_status:
+              Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                ]
+              ),
+            include_unsubscribe_header: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+            topic_data: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::PreferenceTopicGetResponse)
+        end
+        def create(
+          # Id of the preference section to create the topic in.
+          section_id,
+          # The default subscription status applied when a recipient has not set their own.
+          default_status:,
+          # Human-readable name for the preference topic.
+          name:,
+          # Preference controls a recipient may customize for this topic. Defaults to empty
+          # if omitted.
+          allowed_preferences: nil,
+          # Whether to include a list-unsubscribe header on emails for this topic.
+          include_unsubscribe_header: nil,
+          # Default channels delivered for this topic. Defaults to empty if omitted.
+          routing_options: nil,
+          # Arbitrary metadata associated with the topic.
+          topic_data: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieve a topic within a section. Returns 404 if the section does not exist,
+        # the topic does not exist, or the topic belongs to a different section.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::PreferenceTopicGetResponse)
+        end
+        def retrieve(
+          # Id of the subscription preference topic.
+          topic_id,
+          # Id of the preference section.
+          section_id:,
+          request_options: {}
+        )
+        end
+
+        # List the topics in a preference section.
+        sig do
+          params(
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::PreferenceTopicListResponse)
+        end
+        def list(
+          # Id of the preference section.
+          section_id,
+          request_options: {}
+        )
+        end
+
+        # Archive a topic and remove it from its section. Same 404 rules as GET.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def archive(
+          # Id of the subscription preference topic.
+          topic_id,
+          # Id of the preference section.
+          section_id:,
+          request_options: {}
+        )
+        end
+
+        # Replace a topic within a section. Full document replacement; missing optional
+        # fields are cleared. Same 404 rules as GET.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            default_status:
+              Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+                ]
+              ),
+            include_unsubscribe_header: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+            topic_data: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::PreferenceTopicGetResponse)
+        end
+        def replace(
+          # Path param: Id of the subscription preference topic.
+          topic_id,
+          # Path param: Id of the preference section.
+          section_id:,
+          # Body param: The default subscription status applied when a recipient has not set
+          # their own.
+          default_status:,
+          # Body param: Human-readable name for the preference topic.
+          name:,
+          # Body param: Preference controls a recipient may customize. Omit to clear.
+          allowed_preferences: nil,
+          # Body param: Whether to include a list-unsubscribe header on emails for this
+          # topic.
+          include_unsubscribe_header: nil,
+          # Body param: Default channels delivered for this topic. Omit to clear.
+          routing_options: nil,
+          # Body param: Arbitrary metadata associated with the topic. Omit to clear.
+          topic_data: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Courier::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/courier/resources/preference_sections.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class PreferenceSections
+      sig { returns(Courier::Resources::PreferenceSections::Topics) }
+      attr_reader :topics
+
+      # Create a preference section in your workspace. The section id is generated and
+      # returned. Topics are created inside a section via POST
+      # /preferences/sections/{section_id}/topics.
+      sig do
+        params(
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::PreferenceSectionGetResponse)
+      end
+      def create(
+        # Human-readable name for the section.
+        name:,
+        # Whether the section defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the section. Defaults to empty if omitted.
+        routing_options: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a preference section by id, including its topics.
+      sig do
+        params(
+          section_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::PreferenceSectionGetResponse)
+      end
+      def retrieve(
+        # Id of the preference section.
+        section_id,
+        request_options: {}
+      )
+      end
+
+      # List the workspace's preference sections. Each section embeds its topics. Scoped
+      # to the workspace of the API key.
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          Courier::PreferenceSectionListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Archive a preference section. The section must be empty: delete its topics
+      # first, otherwise the request fails with 409.
+      sig do
+        params(
+          section_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def archive(
+        # Id of the preference section.
+        section_id,
+        request_options: {}
+      )
+      end
+
+      # Publish the workspace's preferences page. Takes a snapshot of every section with
+      # its topics under a new published version, making the current state visible on
+      # the hosted preferences page (non-draft).
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          Courier::PublishPreferencesResponse
+        )
+      end
+      def publish(request_options: {})
+      end
+
+      # Replace a preference section. Full document replacement; missing optional fields
+      # are cleared. Topics attached to the section are unaffected.
+      sig do
+        params(
+          section_id: String,
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::PreferenceSectionGetResponse)
+      end
+      def replace(
+        # Id of the preference section.
+        section_id,
+        # Human-readable name for the section.
+        name:,
+        # Whether the section defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the section. Omit to clear.
+        routing_options: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/courier/client.rbs

@@ -42,6 +42,8 @@ module Courier
 
     attr_reader routing_strategies: Courier::Resources::RoutingStrategies
 
+    attr_reader preference_sections: Courier::Resources::PreferenceSections
+
     attr_reader profiles: Courier::Resources::Profiles
 
     attr_reader tenants: Courier::Resources::Tenants

data/sig/courier/models/journeys/template_put_content_params.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    module Journeys
+      type template_put_content_params =
+        { template_id: String, notification_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TemplatePutContentParams < Courier::Models::NotificationContentPutRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def template_id: -> String
+
+        def template_id=: (String _) -> String
+
+        def notification_id: -> String
+
+        def notification_id=: (String _) -> String
+
+        def initialize: (
+          template_id: String,
+          notification_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          template_id: String,
+          notification_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/journeys/template_put_locale_params.rbs

@@ -0,0 +1,40 @@
+module Courier
+  module Models
+    module Journeys
+      type template_put_locale_params =
+        { template_id: String, notification_id: String, locale_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TemplatePutLocaleParams < Courier::Models::NotificationLocalePutRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def template_id: -> String
+
+        def template_id=: (String _) -> String
+
+        def notification_id: -> String
+
+        def notification_id=: (String _) -> String
+
+        def locale_id: -> String
+
+        def locale_id=: (String _) -> String
+
+        def initialize: (
+          template_id: String,
+          notification_id: String,
+          locale_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          template_id: String,
+          notification_id: String,
+          locale_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/journeys/template_retrieve_content_params.rbs

@@ -0,0 +1,36 @@
+module Courier
+  module Models
+    module Journeys
+      type template_retrieve_content_params =
+        { template_id: String, notification_id: String, version: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TemplateRetrieveContentParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor template_id: String
+
+        attr_accessor notification_id: String
+
+        attr_reader version: String?
+
+        def version=: (String) -> String
+
+        def initialize: (
+          template_id: String,
+          notification_id: String,
+          ?version: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          template_id: String,
+          notification_id: String,
+          version: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/preference_section_archive_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type preference_section_archive_params =
+      { section_id: String } & Courier::Internal::Type::request_parameters
+
+    class PreferenceSectionArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor section_id: String
+
+      def initialize: (
+        section_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        section_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/preference_section_create_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type preference_section_create_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/preference_section_create_request.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type preference_section_create_request =
+      {
+        name: String,
+        has_custom_routing: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?
+      }
+
+    class PreferenceSectionCreateRequest < Courier::Internal::Type::BaseModel
+      attr_accessor name: String
+
+      attr_accessor has_custom_routing: bool?
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
+
+      def initialize: (
+        name: String,
+        ?has_custom_routing: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        has_custom_routing: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?
+      }
+    end
+  end
+end

data/sig/courier/models/preference_section_get_response.rbs

@@ -0,0 +1,60 @@
+module Courier
+  module Models
+    type preference_section_get_response =
+      {
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        creator: String?,
+        updated: String?,
+        updater: String?
+      }
+
+    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created: String
+
+      attr_accessor has_custom_routing: bool
+
+      attr_accessor name: String
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]
+
+      attr_accessor topics: ::Array[Courier::PreferenceTopicGetResponse]
+
+      attr_accessor creator: String?
+
+      attr_accessor updated: String?
+
+      attr_accessor updater: String?
+
+      def initialize: (
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        ?creator: String?,
+        ?updated: String?,
+        ?updater: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::PreferenceTopicGetResponse],
+        creator: String?,
+        updated: String?,
+        updater: String?
+      }
+    end
+  end
+end

data/sig/courier/models/preference_section_list_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type preference_section_list_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class PreferenceSectionListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end