trycourier 4.16.0 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76179334776f39db558748f8c3787c82edfee017d5a1a9eeb4a06593b1dd559e
-  data.tar.gz: a42dc6fb130e7991fa52cbb683fc8d4d0a562ec06d8a79a647cdc15cbc15ff3b
+  metadata.gz: 1ebaf44c61a0ef71f4361dcc7d1c86fd966ef63dad937597e9aa3305eac0eb0c
+  data.tar.gz: 77043c6e894d91ae5bfcab16c10deebe37297817112069e094a88f0927452aa8
 SHA512:
-  metadata.gz: 55b1ecd065e30b3c435d09df5f39a9237706ff4eb037a67d6e2ada6610187350403b17f446f0c2f3da9e59e2e0c3d4711303312e67258d3ccad3679f29cd8765
-  data.tar.gz: af2d0c62c7146d14047ae2ca71c1f09c95e856708d223e6f32df0e67b64dfef667664d8ee9a7dc95c828a10f9d17bc12ba19d870ffaf218b8c381b66f152e539
+  metadata.gz: eada95e02ef63ffe5351c64ccbafa522e8a36d02b0ad84c15a250c493684b9676538c2c72d72ee6c613096bfb2de1e40b00cef51134af44de63229937ad22036
+  data.tar.gz: 1579153d043a077c6d4561276bfbbabbd986ddb115bea3552b5301717bb9e5c80855176573fc50789dc9293fd20970db74f5d003f1e3fe7e890128d236b4b65c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.17.0 (2026-06-24)
+
+Full Changelog: [v4.16.0...v4.17.0](https://github.com/trycourier/courier-ruby/compare/v4.16.0...v4.17.0)
+
+### Features
+
+* **preferences:** workspace preference sections & nested topics endpoints ([d53ac7b](https://github.com/trycourier/courier-ruby/commit/d53ac7b093745632465f9b8fc4136964e48ed88f))
+
 ## 4.16.0 (2026-06-23)
 
 Full Changelog: [v4.15.0...v4.16.0](https://github.com/trycourier/courier-ruby/compare/v4.15.0...v4.16.0)

data/lib/courier/client.rb

@@ -66,6 +66,9 @@ module Courier
     # @return [Courier::Resources::RoutingStrategies]
     attr_reader :routing_strategies
 
+    # @return [Courier::Resources::PreferenceSections]
+    attr_reader :preference_sections
+
     # @return [Courier::Resources::Profiles]
     attr_reader :profiles
 
@@ -155,6 +158,7 @@ module Courier
       @requests = Courier::Resources::Requests.new(client: self)
       @notifications = Courier::Resources::Notifications.new(client: self)
       @routing_strategies = Courier::Resources::RoutingStrategies.new(client: self)
+      @preference_sections = Courier::Resources::PreferenceSections.new(client: self)
       @profiles = Courier::Resources::Profiles.new(client: self)
       @tenants = Courier::Resources::Tenants.new(client: self)
       @translations = Courier::Resources::Translations.new(client: self)

data/lib/courier/models/preference_section_archive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#archive
+    class PreferenceSectionArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute section_id
+      #
+      #   @return [String]
+      required :section_id, String
+
+      # @!method initialize(section_id:, request_options: {})
+      #   @param section_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_section_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#create
+    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_section_create_request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceSectionCreateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   Human-readable name for the section.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute has_custom_routing
+      #   Whether the section defines custom routing for its topics.
+      #
+      #   @return [Boolean, nil]
+      optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute routing_options
+      #   Default channels for the section. Defaults to empty if omitted.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
+      optional :routing_options,
+               -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
+               nil?: true
+
+      # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
+      #   Request body for creating a 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. Defaults to empty if omitted.
+    end
+  end
+end

data/lib/courier/models/preference_section_get_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#create
+    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The preference section id.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   ISO-8601 timestamp of when the section was created.
+      #
+      #   @return [String]
+      required :created, String
+
+      # @!attribute has_custom_routing
+      #   Whether the section defines custom routing for its topics.
+      #
+      #   @return [Boolean]
+      required :has_custom_routing, Courier::Internal::Type::Boolean
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing_options
+      #   Default channels for the section. May be empty.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>]
+      required :routing_options, -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] }
+
+      # @!attribute topics
+      #   The topics contained in this section.
+      #
+      #   @return [Array<Courier::Models::PreferenceTopicGetResponse>]
+      required :topics, -> { Courier::Internal::Type::ArrayOf[Courier::PreferenceTopicGetResponse] }
+
+      # @!attribute creator
+      #   Id of the creator.
+      #
+      #   @return [String, nil]
+      optional :creator, String, nil?: true
+
+      # @!attribute updated
+      #   ISO-8601 timestamp of the last update.
+      #
+      #   @return [String, nil]
+      optional :updated, String, nil?: true
+
+      # @!attribute updater
+      #   Id of the last updater.
+      #
+      #   @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)
+      #   A preference section in your workspace, including its topics.
+      #
+      #   @param id [String] The preference section id.
+      #
+      #   @param created [String] ISO-8601 timestamp of when the section was created.
+      #
+      #   @param has_custom_routing [Boolean] Whether the section defines custom routing for its topics.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>] Default channels for the section. May be empty.
+      #
+      #   @param topics [Array<Courier::Models::PreferenceTopicGetResponse>] The topics contained in this section.
+      #
+      #   @param creator [String, nil] Id of the creator.
+      #
+      #   @param updated [String, nil] ISO-8601 timestamp of the last update.
+      #
+      #   @param updater [String, nil] Id of the last updater.
+    end
+  end
+end

data/lib/courier/models/preference_section_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#list
+    class PreferenceSectionListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_section_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#list
+    class PreferenceSectionListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::PreferenceSectionGetResponse>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::PreferenceSectionGetResponse] }
+
+      # @!method initialize(results:)
+      #   The workspace's preference sections, each with its topics.
+      #
+      #   @param results [Array<Courier::Models::PreferenceSectionGetResponse>]
+    end
+  end
+end

data/lib/courier/models/preference_section_publish_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#publish
+    class PreferenceSectionPublishParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_section_replace_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#replace
+    class PreferenceSectionReplaceParams < Courier::Models::PreferenceSectionReplaceRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute section_id
+      #
+      #   @return [String]
+      required :section_id, String
+
+      # @!method initialize(section_id:, request_options: {})
+      #   @param section_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_section_replace_request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   Human-readable name for the section.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute has_custom_routing
+      #   Whether the section defines custom routing for its topics.
+      #
+      #   @return [Boolean, nil]
+      optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute routing_options
+      #   Default channels for the section. Omit to clear.
+      #
+      #   @return [Array<Symbol, Courier::Models::ChannelClassification>, nil]
+      optional :routing_options,
+               -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
+               nil?: true
+
+      # @!method initialize(name:, has_custom_routing: nil, routing_options: nil)
+      #   Request body for replacing a preference section. Full document replacement;
+      #   missing optional fields are cleared.
+      #
+      #   @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.
+    end
+  end
+end

data/lib/courier/models/preference_section_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::PreferenceSections#retrieve
+    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute section_id
+      #
+      #   @return [String]
+      required :section_id, String
+
+      # @!method initialize(section_id:, request_options: {})
+      #   @param section_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/preference_sections/topic_archive_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module PreferenceSections
+      # @see Courier::Resources::PreferenceSections::Topics#archive
+      class TopicArchiveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(section_id:, topic_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param topic_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_sections/topic_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module PreferenceSections
+      # @see Courier::Resources::PreferenceSections::Topics#create
+      class TopicCreateParams < Courier::Models::PreferenceTopicCreateRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!method initialize(section_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_sections/topic_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module PreferenceSections
+      # @see Courier::Resources::PreferenceSections::Topics#list
+      class TopicListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!method initialize(section_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_sections/topic_replace_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module PreferenceSections
+      # @see Courier::Resources::PreferenceSections::Topics#replace
+      class TopicReplaceParams < Courier::Models::PreferenceTopicReplaceRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(section_id:, topic_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param topic_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_sections/topic_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module PreferenceSections
+      # @see Courier::Resources::PreferenceSections::Topics#retrieve
+      class TopicRetrieveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(section_id:, topic_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param topic_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/preference_topic_create_request.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class PreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute default_status
+      #   The default subscription status applied when a recipient has not set their own.
+      #
+      #   @return [Symbol, Courier::Models::PreferenceTopicCreateRequest::DefaultStatus]
+      required :default_status, enum: -> { Courier::PreferenceTopicCreateRequest::DefaultStatus }
+
+      # @!attribute name
+      #   Human-readable name for the preference topic.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute allowed_preferences
+      #   Preference controls a recipient may customize for this topic. Defaults to empty
+      #   if omitted.
+      #
+      #   @return [Array<Symbol, Courier::Models::PreferenceTopicCreateRequest::AllowedPreference>, nil]
+      optional :allowed_preferences,
+               -> {
+                 Courier::Internal::Type::ArrayOf[enum: Courier::PreferenceTopicCreateRequest::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. Defaults to empty if omitted.
+      #
+      #   @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.
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::PreferenceTopicCreateRequest} for more details.
+      #
+      #   Request body for creating a preference topic.
+      #
+      #   @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.
+
+      # The default subscription status applied when a recipient has not set their own.
+      #
+      # @see Courier::Models::PreferenceTopicCreateRequest#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