trycourier 4.15.0 → 4.17.0

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

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/journeys/templates.rb

@@ -180,6 +180,81 @@ module Courier
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Journeys::TemplatePutContentParams} for more details.
+        #
+        # Replace the elemental content of a journey-scoped notification template.
+        # Overwrites all elements in the template draft with the provided content.
+        #
+        # @overload put_content(notification_id, template_id:, content:, state: nil, request_options: {})
+        #
+        # @param notification_id [String] Path param: Notification template id
+        #
+        # @param template_id [String] Path param: Journey id
+        #
+        # @param content [Courier::Models::NotificationContentPutRequest::Content] Body param: Elemental content payload. The server defaults `version` when omitte
+        #
+        # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::NotificationContentMutationResponse]
+        #
+        # @see Courier::Models::Journeys::TemplatePutContentParams
+        def put_content(notification_id, params)
+          parsed, options = Courier::Journeys::TemplatePutContentParams.dump_request(params)
+          template_id =
+            parsed.delete(:template_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["journeys/%1$s/templates/%2$s/content", template_id, notification_id],
+            body: parsed,
+            model: Courier::NotificationContentMutationResponse,
+            options: options
+          )
+        end
+
+        # Set locale-specific content overrides for a journey-scoped notification
+        # template. Each element override must reference an existing element by ID.
+        #
+        # @overload put_locale(locale_id, template_id:, notification_id:, elements:, state: nil, request_options: {})
+        #
+        # @param locale_id [String] Path param: Locale code (e.g., `es`, `fr`, `pt-BR`).
+        #
+        # @param template_id [String] Path param: Journey id
+        #
+        # @param notification_id [String] Path param: Notification template id
+        #
+        # @param elements [Array<Courier::Models::NotificationLocalePutRequest::Element>] Body param: Elements with locale-specific content overrides.
+        #
+        # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::NotificationContentMutationResponse]
+        #
+        # @see Courier::Models::Journeys::TemplatePutLocaleParams
+        def put_locale(locale_id, params)
+          parsed, options = Courier::Journeys::TemplatePutLocaleParams.dump_request(params)
+          template_id =
+            parsed.delete(:template_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          notification_id =
+            parsed.delete(:notification_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["journeys/%1$s/templates/%2$s/locales/%3$s", template_id, notification_id, locale_id],
+            body: parsed,
+            model: Courier::NotificationContentMutationResponse,
+            options: options
+          )
+        end
+
         # Replace the journey-scoped notification template draft.
         #
         # @overload replace(notification_id, template_id:, notification:, state: nil, request_options: {})
@@ -212,6 +287,44 @@ module Courier
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Journeys::TemplateRetrieveContentParams} for more details.
+        #
+        # Retrieve the elemental content of a journey-scoped notification template. The
+        # response contains the versioned elements along with their content checksums,
+        # which can be used to detect changes between versions. Pass `?version=draft`
+        # (default `published`) to retrieve the working draft, or `?version=vN` for a
+        # historical version.
+        #
+        # @overload retrieve_content(notification_id, template_id:, version: nil, request_options: {})
+        #
+        # @param notification_id [String] Path param: Notification template id
+        #
+        # @param template_id [String] Path param: Journey id
+        #
+        # @param version [String] Query param: Accepts `draft`, `published`, or a version string (e.g., `v001`). D
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::NotificationContentGetResponse]
+        #
+        # @see Courier::Models::Journeys::TemplateRetrieveContentParams
+        def retrieve_content(notification_id, params)
+          parsed, options = Courier::Journeys::TemplateRetrieveContentParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
+          template_id =
+            parsed.delete(:template_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["journeys/%1$s/templates/%2$s/content", template_id, notification_id],
+            query: query,
+            model: Courier::NotificationContentGetResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Courier::Client]