trycourier 4.15.0 → 4.17.0

data/lib/courier/resources/preference_sections/topics.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class PreferenceSections
+      class Topics
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::PreferenceSections::TopicCreateParams} for more details.
+        #
+        # Create a subscription preference topic inside a section. Fails with 404 if the
+        # section does not exist. The topic id is generated and returned.
+        #
+        # @overload create(section_id, default_status:, name:, allowed_preferences: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, request_options: {})
+        #
+        # @param section_id [String] Id of the preference section to create the topic in.
+        #
+        # @param default_status [Symbol, Courier::Models::PreferenceTopicCreateRequest::DefaultStatus] The default subscription status applied when a recipient has not set their own.
+        #
+        # @param name [String] Human-readable name for the preference topic.
+        #
+        # @param allowed_preferences [Array<Symbol, Courier::Models::PreferenceTopicCreateRequest::AllowedPreference>, nil] Preference controls a recipient may customize for this topic. Defaults to empty
+        #
+        # @param include_unsubscribe_header [Boolean, nil] Whether to include a list-unsubscribe header on emails for this topic.
+        #
+        # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels delivered for this topic. Defaults to empty if omitted.
+        #
+        # @param topic_data [Hash{Symbol=>Object}, nil] Arbitrary metadata associated with the topic.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PreferenceTopicGetResponse]
+        #
+        # @see Courier::Models::PreferenceSections::TopicCreateParams
+        def create(section_id, params)
+          parsed, options = Courier::PreferenceSections::TopicCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["preferences/sections/%1$s/topics", section_id],
+            body: parsed,
+            model: Courier::PreferenceTopicGetResponse,
+            options: 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.
+        #
+        # @overload retrieve(topic_id, section_id:, request_options: {})
+        #
+        # @param topic_id [String] Id of the subscription preference topic.
+        #
+        # @param section_id [String] Id of the preference section.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PreferenceTopicGetResponse]
+        #
+        # @see Courier::Models::PreferenceSections::TopicRetrieveParams
+        def retrieve(topic_id, params)
+          parsed, options = Courier::PreferenceSections::TopicRetrieveParams.dump_request(params)
+          section_id =
+            parsed.delete(:section_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["preferences/sections/%1$s/topics/%2$s", section_id, topic_id],
+            model: Courier::PreferenceTopicGetResponse,
+            options: options
+          )
+        end
+
+        # List the topics in a preference section.
+        #
+        # @overload list(section_id, request_options: {})
+        #
+        # @param section_id [String] Id of the preference section.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PreferenceTopicListResponse]
+        #
+        # @see Courier::Models::PreferenceSections::TopicListParams
+        def list(section_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["preferences/sections/%1$s/topics", section_id],
+            model: Courier::PreferenceTopicListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Archive a topic and remove it from its section. Same 404 rules as GET.
+        #
+        # @overload archive(topic_id, section_id:, request_options: {})
+        #
+        # @param topic_id [String] Id of the subscription preference topic.
+        #
+        # @param section_id [String] Id of the preference section.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Courier::Models::PreferenceSections::TopicArchiveParams
+        def archive(topic_id, params)
+          parsed, options = Courier::PreferenceSections::TopicArchiveParams.dump_request(params)
+          section_id =
+            parsed.delete(:section_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["preferences/sections/%1$s/topics/%2$s", section_id, topic_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::PreferenceSections::TopicReplaceParams} for more details.
+        #
+        # Replace a topic within a section. Full document replacement; missing optional
+        # fields are cleared. Same 404 rules as GET.
+        #
+        # @overload replace(topic_id, section_id:, default_status:, name:, allowed_preferences: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, request_options: {})
+        #
+        # @param topic_id [String] Path param: Id of the subscription preference topic.
+        #
+        # @param section_id [String] Path param: Id of the preference section.
+        #
+        # @param default_status [Symbol, Courier::Models::PreferenceTopicReplaceRequest::DefaultStatus] Body param: The default subscription status applied when a recipient has not set
+        #
+        # @param name [String] Body param: Human-readable name for the preference topic.
+        #
+        # @param allowed_preferences [Array<Symbol, Courier::Models::PreferenceTopicReplaceRequest::AllowedPreference>, nil] Body param: Preference controls a recipient may customize. Omit to clear.
+        #
+        # @param include_unsubscribe_header [Boolean, nil] Body param: Whether to include a list-unsubscribe header on emails for this topi
+        #
+        # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Body param: Default channels delivered for this topic. Omit to clear.
+        #
+        # @param topic_data [Hash{Symbol=>Object}, nil] Body param: Arbitrary metadata associated with the topic. Omit to clear.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PreferenceTopicGetResponse]
+        #
+        # @see Courier::Models::PreferenceSections::TopicReplaceParams
+        def replace(topic_id, params)
+          parsed, options = Courier::PreferenceSections::TopicReplaceParams.dump_request(params)
+          section_id =
+            parsed.delete(:section_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["preferences/sections/%1$s/topics/%2$s", section_id, topic_id],
+            body: parsed,
+            model: Courier::PreferenceTopicGetResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Courier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/courier/resources/preference_sections.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class PreferenceSections
+      # @return [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.
+      #
+      # @overload create(name:, has_custom_routing: nil, routing_options: nil, request_options: {})
+      #
+      # @param name [String] Human-readable name for the section.
+      #
+      # @param has_custom_routing [Boolean, nil] Whether the section defines custom routing for its topics.
+      #
+      # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the section. Defaults to empty if omitted.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::PreferenceSectionGetResponse]
+      #
+      # @see Courier::Models::PreferenceSectionCreateParams
+      def create(params)
+        parsed, options = Courier::PreferenceSectionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "preferences/sections",
+          body: parsed,
+          model: Courier::PreferenceSectionGetResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a preference section by id, including its topics.
+      #
+      # @overload retrieve(section_id, request_options: {})
+      #
+      # @param section_id [String] Id of the preference section.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::PreferenceSectionGetResponse]
+      #
+      # @see Courier::Models::PreferenceSectionRetrieveParams
+      def retrieve(section_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["preferences/sections/%1$s", section_id],
+          model: Courier::PreferenceSectionGetResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List the workspace's preference sections. Each section embeds its topics. Scoped
+      # to the workspace of the API key.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::PreferenceSectionListResponse]
+      #
+      # @see Courier::Models::PreferenceSectionListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "preferences/sections",
+          model: Courier::PreferenceSectionListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Archive a preference section. The section must be empty: delete its topics
+      # first, otherwise the request fails with 409.
+      #
+      # @overload archive(section_id, request_options: {})
+      #
+      # @param section_id [String] Id of the preference section.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::PreferenceSectionArchiveParams
+      def archive(section_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["preferences/sections/%1$s", section_id],
+          model: NilClass,
+          options: params[: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).
+      #
+      # @overload publish(request_options: {})
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::PublishPreferencesResponse]
+      #
+      # @see Courier::Models::PreferenceSectionPublishParams
+      def publish(params = {})
+        @client.request(
+          method: :post,
+          path: "preferences/publish",
+          model: Courier::PublishPreferencesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Replace a preference section. Full document replacement; missing optional fields
+      # are cleared. Topics attached to the section are unaffected.
+      #
+      # @overload replace(section_id, name:, has_custom_routing: nil, routing_options: nil, request_options: {})
+      #
+      # @param section_id [String] Id of the preference section.
+      #
+      # @param name [String] Human-readable name for the section.
+      #
+      # @param has_custom_routing [Boolean, nil] Whether the section defines custom routing for its topics.
+      #
+      # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the section. Omit to clear.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::PreferenceSectionGetResponse]
+      #
+      # @see Courier::Models::PreferenceSectionReplaceParams
+      def replace(section_id, params)
+        parsed, options = Courier::PreferenceSectionReplaceParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["preferences/sections/%1$s", section_id],
+          body: parsed,
+          model: Courier::PreferenceSectionGetResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+        @topics = Courier::Resources::PreferenceSections::Topics.new(client: client)
+      end
+    end
+  end
+end

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -63,15 +63,19 @@ require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/journey_publish_request"
 require_relative "courier/models/journey_template_create_request"
 require_relative "courier/models/journey_template_publish_request"
+require_relative "courier/models/notification_content_put_request"
+require_relative "courier/models/notification_locale_put_request"
 require_relative "courier/models/journey_template_replace_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/preference_section_create_request"
+require_relative "courier/models/preference_section_replace_request"
+require_relative "courier/models/preference_topic_create_request"
+require_relative "courier/models/preference_topic_replace_request"
 require_relative "courier/models/routing_strategy_create_request"
 require_relative "courier/models/routing_strategy_replace_request"
 require_relative "courier/models/base_template_tenant_association"
@@ -191,7 +195,10 @@ require_relative "courier/models/journeys/template_create_params"
 require_relative "courier/models/journeys/template_list_params"
 require_relative "courier/models/journeys/template_list_versions_params"
 require_relative "courier/models/journeys/template_publish_params"
+require_relative "courier/models/journeys/template_put_content_params"
+require_relative "courier/models/journeys/template_put_locale_params"
 require_relative "courier/models/journeys/template_replace_params"
+require_relative "courier/models/journeys/template_retrieve_content_params"
 require_relative "courier/models/journeys/template_retrieve_params"
 require_relative "courier/models/journey_segment_trigger_node"
 require_relative "courier/models/journey_send_node"
@@ -272,7 +279,22 @@ require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
 require_relative "courier/models/post_tenant_template_publish_response"
 require_relative "courier/models/preference"
+require_relative "courier/models/preference_section_archive_params"
+require_relative "courier/models/preference_section_create_params"
+require_relative "courier/models/preference_section_get_response"
+require_relative "courier/models/preference_section_list_params"
+require_relative "courier/models/preference_section_list_response"
+require_relative "courier/models/preference_section_publish_params"
+require_relative "courier/models/preference_section_replace_params"
+require_relative "courier/models/preference_section_retrieve_params"
+require_relative "courier/models/preference_sections/topic_archive_params"
+require_relative "courier/models/preference_sections/topic_create_params"
+require_relative "courier/models/preference_sections/topic_list_params"
+require_relative "courier/models/preference_sections/topic_replace_params"
+require_relative "courier/models/preference_sections/topic_retrieve_params"
 require_relative "courier/models/preference_status"
+require_relative "courier/models/preference_topic_get_response"
+require_relative "courier/models/preference_topic_list_response"
 require_relative "courier/models/profile_create_params"
 require_relative "courier/models/profile_create_response"
 require_relative "courier/models/profile_delete_params"
@@ -297,6 +319,7 @@ require_relative "courier/models/providers/catalog_list_params"
 require_relative "courier/models/providers/catalog_list_response"
 require_relative "courier/models/providers_catalog_entry"
 require_relative "courier/models/provider_update_params"
+require_relative "courier/models/publish_preferences_response"
 require_relative "courier/models/put_subscriptions_recipient"
 require_relative "courier/models/put_tenant_template_response"
 require_relative "courier/models/recipient_preferences"
@@ -405,6 +428,8 @@ 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/preference_sections"
+require_relative "courier/resources/preference_sections/topics"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
 require_relative "courier/resources/providers"

data/rbi/courier/client.rbi

@@ -61,6 +61,9 @@ module Courier
     sig { returns(Courier::Resources::RoutingStrategies) }
     attr_reader :routing_strategies
 
+    sig { returns(Courier::Resources::PreferenceSections) }
+    attr_reader :preference_sections
+
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 

data/rbi/courier/models/journeys/template_put_content_params.rbi

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

data/rbi/courier/models/journeys/template_put_locale_params.rbi

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

data/rbi/courier/models/journeys/template_retrieve_content_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Journeys
+      class TemplateRetrieveContentParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Journeys::TemplateRetrieveContentParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :template_id
+
+        sig { returns(String) }
+        attr_accessor :notification_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(
+            template_id: String,
+            notification_id: String,
+            version: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          template_id:,
+          notification_id:,
+          # Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+          # `published`.
+          version: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              template_id: String,
+              notification_id: String,
+              version: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_section_archive_params.rbi

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

data/rbi/courier/models/preference_section_create_params.rbi

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