trycourier 4.16.0 → 4.17.0

data/lib/courier/models/preference_topic_get_response.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The preference topic id.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute allowed_preferences
+      #   Preference controls a recipient may customize. May be empty.
+      #
+      #   @return [Array<Symbol, Courier::Models::PreferenceTopicGetResponse::AllowedPreference>]
+      required :allowed_preferences,
+               -> { Courier::Internal::Type::ArrayOf[enum: Courier::PreferenceTopicGetResponse::AllowedPreference] }
+
+      # @!attribute created
+      #   ISO-8601 timestamp of when the topic was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute default_status
+      #   The default subscription status applied when a recipient has not set their own.
+      #
+      #   @return [Symbol, Courier::Models::PreferenceTopicGetResponse::DefaultStatus]
+      required :default_status, enum: -> { Courier::PreferenceTopicGetResponse::DefaultStatus }
+
+      # @!attribute include_unsubscribe_header
+      #   Whether a list-unsubscribe header is included on emails for this topic.
+      #
+      #   @return [Boolean]
+      required :include_unsubscribe_header, Courier::Internal::Type::Boolean
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing_options
+      #   Default channels delivered for this topic. May be empty.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
+      required :routing_options, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+      # @!attribute topic_data
+      #   Arbitrary metadata associated with the topic.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :topic_data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute updated
+      #   ISO-8601 timestamp of the last update.
+      #
+      #   @return [String]
+      required :updated, String
+
+      # @!attribute creator
+      #   Id of the creator.
+      #
+      #   @return [String, nil]
+      optional :creator, String, nil?: true
+
+      # @!attribute updater
+      #   Id of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String, nil?: true
+
+      # @!method initialize(id:, allowed_preferences:, created:, default_status:, include_unsubscribe_header:, name:, routing_options:, topic_data:, updated:, creator: nil, updater: nil)
+      #   A subscription preference topic in your workspace.
+      #
+      #   @param id [String] The preference topic id.
+      #
+      #   @param allowed_preferences [Array<Symbol, Courier::Models::PreferenceTopicGetResponse::AllowedPreference>] Preference controls a recipient may customize. May be empty.
+      #
+      #   @param created [String] ISO-8601 timestamp of when the topic was created.
+      #
+      #   @param default_status [Symbol, Courier::Models::PreferenceTopicGetResponse::DefaultStatus] The default subscription status applied when a recipient has not set their own.
+      #
+      #   @param include_unsubscribe_header [Boolean] Whether a list-unsubscribe header is included on emails for this topic.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels delivered for this topic. May be empty.
+      #
+      #   @param topic_data [Hash{Symbol=>Object}] Arbitrary metadata associated with the topic.
+      #
+      #   @param updated [String] ISO-8601 timestamp of the last update.
+      #
+      #   @param creator [String, nil] Id of the creator.
+      #
+      #   @param updater [String, nil] Id of the last updater.
+
+      # A preference control a recipient may customize for a topic.
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        SNOOZE = :snooze
+        CHANNEL_PREFERENCES = :channel_preferences
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The default subscription status applied when a recipient has not set their own.
+      #
+      # @see Courier::Models::PreferenceTopicGetResponse#default_status
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        OPTED_OUT = :OPTED_OUT
+        OPTED_IN = :OPTED_IN
+        REQUIRED = :REQUIRED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_topic_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceTopicListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::PreferenceTopicGetResponse>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::PreferenceTopicGetResponse] }
+
+      # @!method initialize(results:)
+      #   Topics contained in a preference section.
+      #
+      #   @param results [Array<Courier::Models::PreferenceTopicGetResponse>]
+    end
+  end
+end

data/lib/courier/models/preference_topic_replace_request.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
+      # @!attribute default_status
+      #   The default subscription status applied when a recipient has not set their own.
+      #
+      #   @return [Symbol, Courier::Models::PreferenceTopicReplaceRequest::DefaultStatus]
+      required :default_status, enum: -> { Courier::PreferenceTopicReplaceRequest::DefaultStatus }
+
+      # @!attribute name
+      #   Human-readable name for the preference topic.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute allowed_preferences
+      #   Preference controls a recipient may customize. Omit to clear.
+      #
+      #   @return [Array<Symbol, Courier::Models::PreferenceTopicReplaceRequest::AllowedPreference>, nil]
+      optional :allowed_preferences,
+               -> {
+                 Courier::Internal::Type::ArrayOf[enum: Courier::PreferenceTopicReplaceRequest::AllowedPreference]
+               },
+               nil?: true
+
+      # @!attribute include_unsubscribe_header
+      #   Whether to include a list-unsubscribe header on emails for this topic.
+      #
+      #   @return [Boolean, nil]
+      optional :include_unsubscribe_header, Courier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute routing_options
+      #   Default channels delivered for this topic. Omit to clear.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
+      optional :routing_options,
+               -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
+               nil?: true
+
+      # @!attribute topic_data
+      #   Arbitrary metadata associated with the topic. Omit to clear.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :topic_data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(default_status:, name:, allowed_preferences: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
+      #   Request body for replacing a preference topic. Full document replacement;
+      #   missing optional fields are cleared.
+      #
+      #   @param default_status [Symbol, Courier::Models::PreferenceTopicReplaceRequest::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::PreferenceTopicReplaceRequest::AllowedPreference>, nil] Preference controls a recipient may customize. Omit to clear.
+      #
+      #   @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. Omit to clear.
+      #
+      #   @param topic_data [Hash{Symbol=>Object}, nil] Arbitrary metadata associated with the topic. Omit to clear.
+
+      # The default subscription status applied when a recipient has not set their own.
+      #
+      # @see Courier::Models::PreferenceTopicReplaceRequest#default_status
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        OPTED_OUT = :OPTED_OUT
+        OPTED_IN = :OPTED_IN
+        REQUIRED = :REQUIRED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A preference control a recipient may customize for a topic.
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        SNOOZE = :snooze
+        CHANNEL_PREFERENCES = :channel_preferences
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/publish_preferences_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#publish
+    class PublishPreferencesResponse < Courier::Internal::Type::BaseModel
+      # @!attribute page_id
+      #   Id of the published page snapshot.
+      #
+      #   @return [String]
+      required :page_id, String
+
+      # @!attribute published_at
+      #   ISO-8601 timestamp of the publish.
+      #
+      #   @return [String]
+      required :published_at, String
+
+      # @!attribute published_version
+      #   Monotonic published version (epoch milliseconds).
+      #
+      #   @return [Float]
+      required :published_version, Float
+
+      # @!attribute preview_url
+      #   Draft-mode hosted preferences page URL for previewing.
+      #
+      #   @return [String, nil]
+      optional :preview_url, String, nil?: true
+
+      # @!attribute published_by
+      #   Id of the publisher.
+      #
+      #   @return [String, nil]
+      optional :published_by, String, nil?: true
+
+      # @!method initialize(page_id:, published_at:, published_version:, preview_url: nil, published_by: nil)
+      #   Result of publishing the workspace's preferences page.
+      #
+      #   @param page_id [String] Id of the published page snapshot.
+      #
+      #   @param published_at [String] ISO-8601 timestamp of the publish.
+      #
+      #   @param published_version [Float] Monotonic published version (epoch milliseconds).
+      #
+      #   @param preview_url [String, nil] Draft-mode hosted preferences page URL for previewing.
+      #
+      #   @param published_by [String, nil] Id of the publisher.
+    end
+  end
+end

data/lib/courier/models.rb

@@ -404,8 +404,38 @@ 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
@@ -434,6 +464,8 @@ module Courier
 
   ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
+
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest

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.16.0"
+  VERSION = "4.17.0"
 end