trycourier 4.18.2 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dfe27ef204a57575754464258c3bfc13c6f51426e0566a008322a0d64a0c648
-  data.tar.gz: 69833499b114555c923d2818a4544d2bcc6129f9f5b3773455fb65c85588bb77
+  metadata.gz: 36258d274b2bc67f4059fd4f61a451511a44af84ea33b39a4f35f67e59e5caac
+  data.tar.gz: b94c56826d10822db771e94955e185faaf42d04d4d3d945d86d453323213b89e
 SHA512:
-  metadata.gz: 05d2da79243cb23bef226df3f2c33bbecd6a840bbae09d48d10f2124edd27402aed45d44b0a072c8ad727917ee454745f30a9b743d9e0904ed196d6bdece1ed3
-  data.tar.gz: f7b8d7c2b6e49f099db098bfafcb16b17850880ea050f529e1859f6a014f58612146621603faa107f0395d810c4145958b73b268dad2f38be671cd8f7f1a0b55
+  metadata.gz: 30b1984a1767a07ac87979e4089dcde0c4298c9a5aa974e136fd1bbdc3b88c4a1df4fcf26f53357203e45dcb772915dfcda27e9a74d4ba4282c3c6aadba3b974
+  data.tar.gz: 3e55533431b261294c723be05ad6e0d76a81acb933b98a3e393f855d255e93090d9495adb22d90f6cee9028b41b9d5f08f9b948e91880bdb1a130464c9594163

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.19.0 (2026-07-09)
+
+Full Changelog: [v4.18.2...v4.19.0](https://github.com/trycourier/courier-ruby/compare/v4.18.2...v4.19.0)
+
+### Features
+
+* Add bulk user preference upsert and replace endpoints ([695929f](https://github.com/trycourier/courier-ruby/commit/695929f41a7c07c28ef9c3cb6913890b30759404))
+* Preferences v3 REST fields: section/topic description + publish body ([df7c59d](https://github.com/trycourier/courier-ruby/commit/df7c59d084f401ea9523db27b35bdccfc0696f2f))
+
 ## 4.18.2 (2026-07-09)
 
 Full Changelog: [v4.18.1...v4.18.2](https://github.com/trycourier/courier-ruby/compare/v4.18.1...v4.18.2)

data/lib/courier/models/publish_preferences_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PublishPreferencesRequest < Courier::Internal::Type::BaseModel
+      # @!attribute brand_id
+      #   Brand for the hosted page - "default" (workspace default brand), "none" (no
+      #   brand), or a specific brand id. Defaults to "default".
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
+      # @!attribute description
+      #   Description shown under the heading on the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute heading
+      #   Heading shown at the top of the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :heading, String, nil?: true
+
+      # @!method initialize(brand_id: nil, description: nil, heading: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::PublishPreferencesRequest} for more details.
+      #
+      #   Optional page metadata to apply when publishing the workspace's preferences
+      #   page. All fields are optional; omitted fields fall back to the page defaults
+      #   (and the workspace default brand).
+      #
+      #   @param brand_id [String, nil] Brand for the hosted page - "default" (workspace default brand), "none" (no bran
+      #
+      #   @param description [String, nil] Description shown under the heading on the hosted preferences page.
+      #
+      #   @param heading [String, nil] Heading shown at the top of the hosted preferences page.
+    end
+  end
+end

data/lib/courier/models/users/bulk_preference_topic.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Users
+      class BulkPreferenceTopic < Courier::Internal::Type::BaseModel
+        # @!attribute custom_routing
+        #
+        #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
+        required :custom_routing, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+        # @!attribute has_custom_routing
+        #
+        #   @return [Boolean]
+        required :has_custom_routing, Courier::Internal::Type::Boolean
+
+        # @!attribute status
+        #   The applied subscription status. Echoes the requested value, so it is always
+        #   OPTED_IN or OPTED_OUT.
+        #
+        #   @return [Symbol, Courier::Models::Users::BulkPreferenceTopic::Status]
+        required :status, enum: -> { Courier::Users::BulkPreferenceTopic::Status }
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(custom_routing:, has_custom_routing:, status:, topic_id:)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Users::BulkPreferenceTopic} for more details.
+        #
+        #   A single topic override echoed in a bulk preference response.
+        #
+        #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>]
+        #
+        #   @param has_custom_routing [Boolean]
+        #
+        #   @param status [Symbol, Courier::Models::Users::BulkPreferenceTopic::Status] The applied subscription status. Echoes the requested value, so it is always OPT
+        #
+        #   @param topic_id [String]
+
+        # The applied subscription status. Echoes the requested value, so it is always
+        # OPTED_IN or OPTED_OUT.
+        #
+        # @see Courier::Models::Users::BulkPreferenceTopic#status
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          OPTED_IN = :OPTED_IN
+          OPTED_OUT = :OPTED_OUT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/users/preference_bulk_replace_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Users
+      # @see Courier::Resources::Users::Preferences#bulk_replace
+      class PreferenceBulkReplaceParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute topics
+        #   The complete set of topic overrides for the user. Up to 50 topics may be
+        #   provided. Any existing override not listed here is reset to its topic default;
+        #   an empty array resets every existing override.
+        #
+        #   @return [Array<Courier::Models::Users::PreferenceBulkReplaceParams::Topic>]
+        required :topics,
+                 -> { Courier::Internal::Type::ArrayOf[Courier::Users::PreferenceBulkReplaceParams::Topic] }
+
+        # @!attribute tenant_id
+        #   Update the preferences of a user for this specific tenant context.
+        #
+        #   @return [String, nil]
+        optional :tenant_id, String, nil?: true
+
+        # @!method initialize(user_id:, topics:, tenant_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Users::PreferenceBulkReplaceParams} for more details.
+        #
+        #   @param user_id [String]
+        #
+        #   @param topics [Array<Courier::Models::Users::PreferenceBulkReplaceParams::Topic>] The complete set of topic overrides for the user. Up to 50 topics may be provide
+        #
+        #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+        class Topic < Courier::Internal::Type::BaseModel
+          # @!attribute status
+          #   The subscription status to apply for this topic.
+          #
+          #   @return [Symbol, Courier::Models::Users::PreferenceBulkReplaceParams::Topic::Status]
+          required :status, enum: -> { Courier::Users::PreferenceBulkReplaceParams::Topic::Status }
+
+          # @!attribute topic_id
+          #   A unique identifier associated with a subscription topic.
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!attribute custom_routing
+          #   The channels a user has chosen to receive notifications through for this topic.
+          #
+          #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
+          optional :custom_routing, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+          # @!attribute has_custom_routing
+          #   Whether the recipient has chosen specific delivery channels for this topic.
+          #
+          #   @return [Boolean, nil]
+          optional :has_custom_routing, Courier::Internal::Type::Boolean
+
+          # @!method initialize(status:, topic_id:, custom_routing: nil, has_custom_routing: nil)
+          #   @param status [Symbol, Courier::Models::Users::PreferenceBulkReplaceParams::Topic::Status] The subscription status to apply for this topic.
+          #
+          #   @param topic_id [String] A unique identifier associated with a subscription topic.
+          #
+          #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>] The channels a user has chosen to receive notifications through for this topic.
+          #
+          #   @param has_custom_routing [Boolean] Whether the recipient has chosen specific delivery channels for this topic.
+
+          # The subscription status to apply for this topic.
+          #
+          # @see Courier::Models::Users::PreferenceBulkReplaceParams::Topic#status
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN = :OPTED_IN
+            OPTED_OUT = :OPTED_OUT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/users/preference_bulk_replace_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Users
+      # @see Courier::Resources::Users::Preferences#bulk_replace
+      class PreferenceBulkReplaceResponse < Courier::Internal::Type::BaseModel
+        # @!attribute deleted
+        #   The ids of the overrides that were reset to their topic default.
+        #
+        #   @return [Array<String>]
+        required :deleted, Courier::Internal::Type::ArrayOf[String]
+
+        # @!attribute items
+        #   The complete resulting set of topic overrides for the user.
+        #
+        #   @return [Array<Courier::Models::Users::BulkPreferenceTopic>]
+        required :items, -> { Courier::Internal::Type::ArrayOf[Courier::Users::BulkPreferenceTopic] }
+
+        # @!method initialize(deleted:, items:)
+        #   @param deleted [Array<String>] The ids of the overrides that were reset to their topic default.
+        #
+        #   @param items [Array<Courier::Models::Users::BulkPreferenceTopic>] The complete resulting set of topic overrides for the user.
+      end
+    end
+  end
+end

data/lib/courier/models/users/preference_bulk_update_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Users
+      # @see Courier::Resources::Users::Preferences#bulk_update
+      class PreferenceBulkUpdateParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute topics
+        #   The topics to create or update. Between 1 and 50 topics may be provided in a
+        #   single request.
+        #
+        #   @return [Array<Courier::Models::Users::PreferenceBulkUpdateParams::Topic>]
+        required :topics,
+                 -> { Courier::Internal::Type::ArrayOf[Courier::Users::PreferenceBulkUpdateParams::Topic] }
+
+        # @!attribute tenant_id
+        #   Update the preferences of a user for this specific tenant context.
+        #
+        #   @return [String, nil]
+        optional :tenant_id, String, nil?: true
+
+        # @!method initialize(user_id:, topics:, tenant_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Users::PreferenceBulkUpdateParams} for more details.
+        #
+        #   @param user_id [String]
+        #
+        #   @param topics [Array<Courier::Models::Users::PreferenceBulkUpdateParams::Topic>] The topics to create or update. Between 1 and 50 topics may be provided in a sin
+        #
+        #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+        class Topic < Courier::Internal::Type::BaseModel
+          # @!attribute status
+          #   The subscription status to apply for this topic.
+          #
+          #   @return [Symbol, Courier::Models::Users::PreferenceBulkUpdateParams::Topic::Status]
+          required :status, enum: -> { Courier::Users::PreferenceBulkUpdateParams::Topic::Status }
+
+          # @!attribute topic_id
+          #   A unique identifier associated with a subscription topic.
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!attribute custom_routing
+          #   The channels a user has chosen to receive notifications through for this topic.
+          #
+          #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
+          optional :custom_routing, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+          # @!attribute has_custom_routing
+          #   Whether the recipient has chosen specific delivery channels for this topic.
+          #
+          #   @return [Boolean, nil]
+          optional :has_custom_routing, Courier::Internal::Type::Boolean
+
+          # @!method initialize(status:, topic_id:, custom_routing: nil, has_custom_routing: nil)
+          #   @param status [Symbol, Courier::Models::Users::PreferenceBulkUpdateParams::Topic::Status] The subscription status to apply for this topic.
+          #
+          #   @param topic_id [String] A unique identifier associated with a subscription topic.
+          #
+          #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>] The channels a user has chosen to receive notifications through for this topic.
+          #
+          #   @param has_custom_routing [Boolean] Whether the recipient has chosen specific delivery channels for this topic.
+
+          # The subscription status to apply for this topic.
+          #
+          # @see Courier::Models::Users::PreferenceBulkUpdateParams::Topic#status
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN = :OPTED_IN
+            OPTED_OUT = :OPTED_OUT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/users/preference_bulk_update_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Users
+      # @see Courier::Resources::Users::Preferences#bulk_update
+      class PreferenceBulkUpdateResponse < Courier::Internal::Type::BaseModel
+        # @!attribute errors
+        #   The topics that could not be applied, each with a reason.
+        #
+        #   @return [Array<Courier::Models::Users::PreferenceBulkUpdateResponse::Error>]
+        required :errors,
+                 -> { Courier::Internal::Type::ArrayOf[Courier::Models::Users::PreferenceBulkUpdateResponse::Error] }
+
+        # @!attribute items
+        #   The topics that were successfully created or updated.
+        #
+        #   @return [Array<Courier::Models::Users::BulkPreferenceTopic>]
+        required :items, -> { Courier::Internal::Type::ArrayOf[Courier::Users::BulkPreferenceTopic] }
+
+        # @!method initialize(errors:, items:)
+        #   @param errors [Array<Courier::Models::Users::PreferenceBulkUpdateResponse::Error>] The topics that could not be applied, each with a reason.
+        #
+        #   @param items [Array<Courier::Models::Users::BulkPreferenceTopic>] The topics that were successfully created or updated.
+
+        class Error < Courier::Internal::Type::BaseModel
+          # @!attribute reason
+          #   A human-readable explanation of why the topic could not be applied.
+          #
+          #   @return [String]
+          required :reason, String
+
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(reason:, topic_id:)
+          #   A single topic that could not be applied in a bulk preference request.
+          #
+          #   @param reason [String] A human-readable explanation of why the topic could not be applied.
+          #
+          #   @param topic_id [String]
+        end
+      end
+    end
+  end
+end

data/lib/courier/models/workspace_preference_create_request.rb

@@ -9,6 +9,12 @@ module Courier
       #   @return [String]
       required :name, String
 
+      # @!attribute description
+      #   Optional description shown under the section on the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
       # @!attribute has_custom_routing
       #   Whether the workspace preference defines custom routing for its topics.
       #
@@ -23,11 +29,13 @@ module Courier
                -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
                nil?: true
 
-      # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
+      # @!method initialize(name:, description: nil, has_custom_routing: nil, routing_options: nil)
       #   Request body for creating a workspace preference.
       #
       #   @param name [String] Human-readable name for the workspace preference.
       #
+      #   @param description [String, nil] Optional description shown under the section on the hosted preferences page.
+      #
       #   @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
       #
       #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Defaults to empty if omitted.

data/lib/courier/models/workspace_preference_get_response.rb

@@ -46,6 +46,12 @@ module Courier
       #   @return [String, nil]
       optional :creator, String, nil?: true
 
+      # @!attribute description
+      #   Optional description shown under the section on the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
       # @!attribute updated
       #   ISO-8601 timestamp of the last update.
       #
@@ -58,7 +64,7 @@ module Courier
       #   @return [String, nil]
       optional :updater, String, nil?: true
 
-      # @!method initialize(id:, created:, has_custom_routing:, name:, routing_options:, topics:, creator: nil, updated: nil, updater: nil)
+      # @!method initialize(id:, created:, has_custom_routing:, name:, routing_options:, topics:, creator: nil, description: nil, updated: nil, updater: nil)
       #   A workspace preference in your workspace, including its topics.
       #
       #   @param id [String] The workspace preference id.
@@ -75,6 +81,8 @@ module Courier
       #
       #   @param creator [String, nil] Id of the creator.
       #
+      #   @param description [String, nil] Optional description shown under the section on the hosted preferences page.
+      #
       #   @param updated [String, nil] ISO-8601 timestamp of the last update.
       #
       #   @param updater [String, nil] Id of the last updater.

data/lib/courier/models/workspace_preference_publish_params.rb

@@ -3,7 +3,7 @@
 module Courier
   module Models
     # @see Courier::Resources::WorkspacePreferences#publish
-    class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferencePublishParams < Courier::Models::PublishPreferencesRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/lib/courier/models/workspace_preference_replace_request.rb

@@ -9,6 +9,13 @@ module Courier
       #   @return [String]
       required :name, String
 
+      # @!attribute description
+      #   Optional description shown under the section on the hosted preferences page.
+      #   Omit to clear.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
       # @!attribute has_custom_routing
       #   Whether the workspace preference defines custom routing for its topics.
       #
@@ -23,12 +30,17 @@ module Courier
                -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
                nil?: true
 
-      # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
+      # @!method initialize(name:, description: nil, has_custom_routing: nil, routing_options: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::WorkspacePreferenceReplaceRequest} for more details.
+      #
       #   Request body for replacing a workspace preference. Full document replacement;
       #   missing optional fields are cleared.
       #
       #   @param name [String] Human-readable name for the workspace preference.
       #
+      #   @param description [String, nil] Optional description shown under the section on the hosted preferences page. Omi
+      #
       #   @param has_custom_routing [Boolean, nil] Whether the workspace preference defines custom routing for its topics.
       #
       #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels for the workspace preference. Omit to clear.

data/lib/courier/models/workspace_preference_topic_create_request.rb

@@ -26,6 +26,12 @@ module Courier
                },
                nil?: true
 
+      # @!attribute description
+      #   Optional description shown under the topic on the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
       # @!attribute include_unsubscribe_header
       #   Whether to include a list-unsubscribe header on emails for this topic.
       #
@@ -46,7 +52,7 @@ module Courier
       #   @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)
+      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::WorkspacePreferenceTopicCreateRequest} for more details.
       #
@@ -58,6 +64,8 @@ module Courier
       #
       #   @param allowed_preferences [Array<Symbol, Courier::Models::WorkspacePreferenceTopicCreateRequest::AllowedPreference>, nil] Preference controls a recipient may customize for this topic. Defaults to empty
       #
+      #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page.
+      #
       #   @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.

data/lib/courier/models/workspace_preference_topic_get_response.rb

@@ -64,13 +64,19 @@ module Courier
       #   @return [String, nil]
       optional :creator, String, nil?: true
 
+      # @!attribute description
+      #   Optional description shown under the topic on the hosted preferences page.
+      #
+      #   @return [String, nil]
+      optional :description, 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)
+      # @!method initialize(id:, allowed_preferences:, created:, default_status:, include_unsubscribe_header:, name:, routing_options:, topic_data:, updated:, creator: nil, description: nil, updater: nil)
       #   A subscription preference topic in your workspace.
       #
       #   @param id [String] The preference topic id.
@@ -93,6 +99,8 @@ module Courier
       #
       #   @param creator [String, nil] Id of the creator.
       #
+      #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page.
+      #
       #   @param updater [String, nil] Id of the last updater.
 
       # A preference control a recipient may customize for a topic.

data/lib/courier/models/workspace_preference_topic_replace_request.rb

@@ -25,6 +25,13 @@ module Courier
                },
                nil?: true
 
+      # @!attribute description
+      #   Optional description shown under the topic on the hosted preferences page. Omit
+      #   to clear.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
       # @!attribute include_unsubscribe_header
       #   Whether to include a list-unsubscribe header on emails for this topic.
       #
@@ -45,7 +52,10 @@ module Courier
       #   @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)
+      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::WorkspacePreferenceTopicReplaceRequest} for more details.
+      #
       #   Request body for replacing a preference topic. Full document replacement;
       #   missing optional fields are cleared.
       #
@@ -55,6 +65,8 @@ module Courier
       #
       #   @param allowed_preferences [Array<Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::AllowedPreference>, nil] Preference controls a recipient may customize. Omit to clear.
       #
+      #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page. Omit
+      #
       #   @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.

data/lib/courier/models.rb

@@ -446,6 +446,8 @@ module Courier
 
   ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  PublishPreferencesRequest = Courier::Models::PublishPreferencesRequest
+
   PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
 
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient