trycourier 4.18.1 → 4.19.0

data/rbi/courier/models/workspace_preference_topic_get_response.rbi

@@ -61,6 +61,10 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :creator
 
+      # Optional description shown under the topic on the hosted preferences page.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
       # Id of the last updater.
       sig { returns(T.nilable(String)) }
       attr_accessor :updater
@@ -82,6 +86,7 @@ module Courier
           topic_data: T::Hash[Symbol, T.anything],
           updated: String,
           creator: T.nilable(String),
+          description: T.nilable(String),
           updater: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -106,6 +111,8 @@ module Courier
         updated:,
         # Id of the creator.
         creator: nil,
+        # Optional description shown under the topic on the hosted preferences page.
+        description: nil,
         # Id of the last updater.
         updater: nil
       )
@@ -129,6 +136,7 @@ module Courier
             topic_data: T::Hash[Symbol, T.anything],
             updated: String,
             creator: T.nilable(String),
+            description: T.nilable(String),
             updater: T.nilable(String)
           }
         )

data/rbi/courier/models/workspace_preference_topic_replace_request.rbi

@@ -35,6 +35,11 @@ module Courier
       end
       attr_accessor :allowed_preferences
 
+      # Optional description shown under the topic on the hosted preferences page. Omit
+      # to clear.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
       # Whether to include a list-unsubscribe header on emails for this topic.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :include_unsubscribe_header
@@ -62,6 +67,7 @@ module Courier
                 Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
               ]
             ),
+          description: T.nilable(String),
           include_unsubscribe_header: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -75,6 +81,9 @@ module Courier
         name:,
         # Preference controls a recipient may customize. Omit to clear.
         allowed_preferences: nil,
+        # Optional description shown under the topic on the hosted preferences page. Omit
+        # to clear.
+        description: nil,
         # Whether to include a list-unsubscribe header on emails for this topic.
         include_unsubscribe_header: nil,
         # Default channels delivered for this topic. Omit to clear.
@@ -96,6 +105,7 @@ module Courier
                   Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
                 ]
               ),
+            description: T.nilable(String),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),

data/rbi/courier/models.rbi

@@ -299,6 +299,8 @@ module Courier
 
   MessageProvidersType = Courier::Models::MessageProvidersType
 
+  MessageResendParams = Courier::Models::MessageResendParams
+
   MessageRetrieveParams = Courier::Models::MessageRetrieveParams
 
   MessageRouting = Courier::Models::MessageRouting
@@ -421,6 +423,8 @@ module Courier
 
   ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  PublishPreferencesRequest = Courier::Models::PublishPreferencesRequest
+
   PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
 
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient

data/rbi/courier/resources/messages.rbi

@@ -130,6 +130,25 @@ module Courier
       )
       end
 
+      # Resend a previously sent message. The original send request is loaded from
+      # storage and a brand-new send is enqueued for the same recipient and content,
+      # producing a **new** `messageId` — the original message is not modified.
+      # Throttled by a per-message rate limit; a repeat inside the limit window returns
+      # `429 Too Many Requests`.
+      sig do
+        params(
+          message_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Models::MessageResendResponse)
+      end
+      def resend(
+        # A unique identifier representing the message ID of the original message to
+        # resend.
+        message_id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Courier::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/courier/resources/users/preferences.rbi

@@ -22,6 +22,89 @@ module Courier
         )
         end
 
+        # Replace a user's complete set of preference overrides in a single request. The
+        # topics in the request body become the recipient's entire set of overrides:
+        # listed topics are created or updated, and every existing override that is not
+        # included in the body is reset to its topic default. Submitting an empty `topics`
+        # array is a valid clear-all that resets every existing override.
+        #
+        # This operation is validation-atomic (all-or-nothing): structural validation
+        # fails fast with a single `400`, and if any topic is semantically invalid (an
+        # unknown topic, a `REQUIRED` topic that cannot be opted out, or a custom routing
+        # request that is not available on the workspace's plan) the request returns a
+        # single `400` aggregating every failure in `errors` and writes nothing. On
+        # success it returns `200` with `items` (the complete resulting override set) and
+        # `deleted` (the ids of the overrides that were reset to default).
+        #
+        # Every `topic_id` in the response — in `items`, `deleted`, and any `errors` — is
+        # returned in Courier's canonical topic id form, regardless of the form supplied
+        # in the request.
+        sig do
+          params(
+            user_id: String,
+            topics:
+              T::Array[
+                Courier::Users::PreferenceBulkReplaceParams::Topic::OrHash
+              ],
+            tenant_id: T.nilable(String),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::Models::Users::PreferenceBulkReplaceResponse)
+        end
+        def bulk_replace(
+          # Path param: A unique identifier associated with the user whose preferences you
+          # wish to update.
+          user_id,
+          # Body param: 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.
+          topics:,
+          # Query param: Update the preferences of a user for this specific tenant context.
+          tenant_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Additively create or update a user's preferences for one or more subscription
+        # topics in a single request. Only the topics included in the request body are
+        # created or updated; any existing overrides for topics not listed are left
+        # untouched.
+        #
+        # Structural validation of the request body fails fast with a single `400`. Beyond
+        # that, each topic is processed independently (partial-success, not
+        # all-or-nothing): valid topics are written and returned in `items`, while topics
+        # that cannot be applied are collected in `errors` with a per-topic `reason` (for
+        # example an unknown topic, a `REQUIRED` topic that cannot be opted out, a custom
+        # routing request that is not available on the workspace's plan, or a write
+        # failure). The request therefore returns `200` with both lists whenever the body
+        # is structurally valid.
+        #
+        # Every `topic_id` in the response — in both `items` and `errors` — is returned in
+        # Courier's canonical topic id form, regardless of the form supplied in the
+        # request.
+        sig do
+          params(
+            user_id: String,
+            topics:
+              T::Array[
+                Courier::Users::PreferenceBulkUpdateParams::Topic::OrHash
+              ],
+            tenant_id: T.nilable(String),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::Models::Users::PreferenceBulkUpdateResponse)
+        end
+        def bulk_update(
+          # Path param: A unique identifier associated with the user whose preferences you
+          # wish to update.
+          user_id,
+          # Body param: The topics to create or update. Between 1 and 50 topics may be
+          # provided in a single request.
+          topics:,
+          # Query param: Update the preferences of a user for this specific tenant context.
+          tenant_id: nil,
+          request_options: {}
+        )
+        end
+
         # Remove a user's preferences for a specific subscription topic, resetting the
         # topic to its effective default. This operation is idempotent: deleting a
         # preference that does not exist succeeds with no error.

data/rbi/courier/resources/workspace_preferences/topics.rbi

@@ -19,6 +19,7 @@ module Courier
                   Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
                 ]
               ),
+            description: T.nilable(String),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -36,6 +37,8 @@ module Courier
           # Preference controls a recipient may customize for this topic. Defaults to empty
           # if omitted.
           allowed_preferences: nil,
+          # Optional description shown under the topic on the hosted preferences page.
+          description: nil,
           # Whether to include a list-unsubscribe header on emails for this topic.
           include_unsubscribe_header: nil,
           # Default channels delivered for this topic. Defaults to empty if omitted.
@@ -112,6 +115,7 @@ module Courier
                   Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
                 ]
               ),
+            description: T.nilable(String),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -131,6 +135,9 @@ module Courier
           name:,
           # Body param: Preference controls a recipient may customize. Omit to clear.
           allowed_preferences: nil,
+          # Body param: Optional description shown under the topic on the hosted preferences
+          # page. Omit to clear.
+          description: nil,
           # Body param: Whether to include a list-unsubscribe header on emails for this
           # topic.
           include_unsubscribe_header: nil,

data/rbi/courier/resources/workspace_preferences.rbi

@@ -12,6 +12,7 @@ module Courier
       sig do
         params(
           name: String,
+          description: T.nilable(String),
           has_custom_routing: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -21,6 +22,8 @@ module Courier
       def create(
         # Human-readable name for the workspace preference.
         name:,
+        # Optional description shown under the section on the hosted preferences page.
+        description: nil,
         # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
         # Default channels for the workspace preference. Defaults to empty if omitted.
@@ -72,11 +75,23 @@ module Courier
       # preference with its topics under a new published version, making the current
       # state visible on the hosted preferences page (non-draft).
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          Courier::PublishPreferencesResponse
-        )
+        params(
+          brand_id: T.nilable(String),
+          description: T.nilable(String),
+          heading: T.nilable(String),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::PublishPreferencesResponse)
       end
-      def publish(request_options: {})
+      def publish(
+        # Brand for the hosted page - "default" (workspace default brand), "none" (no
+        # brand), or a specific brand id. Defaults to "default".
+        brand_id: nil,
+        # Description shown under the heading on the hosted preferences page.
+        description: nil,
+        # Heading shown at the top of the hosted preferences page.
+        heading: nil,
+        request_options: {}
+      )
       end
 
       # Replace a workspace preference. Full document replacement; missing optional
@@ -85,6 +100,7 @@ module Courier
         params(
           section_id: String,
           name: String,
+          description: T.nilable(String),
           has_custom_routing: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -96,6 +112,9 @@ module Courier
         section_id,
         # Human-readable name for the workspace preference.
         name:,
+        # Optional description shown under the section on the hosted preferences page.
+        # Omit to clear.
+        description: nil,
         # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
         # Default channels for the workspace preference. Omit to clear.

data/sig/courier/models/message_resend_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type message_resend_params =
+      { message_id: String } & Courier::Internal::Type::request_parameters
+
+    class MessageResendParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor message_id: String
+
+      def initialize: (
+        message_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/message_resend_response.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type message_resend_response = { message_id: String }
+
+    class MessageResendResponse < Courier::Internal::Type::BaseModel
+      attr_accessor message_id: String
+
+      def initialize: (message_id: String) -> void
+
+      def to_hash: -> { message_id: String }
+    end
+  end
+end

data/sig/courier/models/publish_preferences_request.rbs

@@ -0,0 +1,26 @@
+module Courier
+  module Models
+    type publish_preferences_request =
+      { brand_id: String?, description: String?, heading: String? }
+
+    class PublishPreferencesRequest < Courier::Internal::Type::BaseModel
+      attr_accessor brand_id: String?
+
+      attr_accessor description: String?
+
+      attr_accessor heading: String?
+
+      def initialize: (
+        ?brand_id: String?,
+        ?description: String?,
+        ?heading: String?
+      ) -> void
+
+      def to_hash: -> {
+        brand_id: String?,
+        description: String?,
+        heading: String?
+      }
+    end
+  end
+end

data/sig/courier/models/users/bulk_preference_topic.rbs

@@ -0,0 +1,48 @@
+module Courier
+  module Models
+    module Users
+      type bulk_preference_topic =
+        {
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        }
+
+      class BulkPreferenceTopic < Courier::Internal::Type::BaseModel
+        attr_accessor custom_routing: ::Array[Courier::Models::channel_classification]
+
+        attr_accessor has_custom_routing: bool
+
+        attr_accessor status: Courier::Models::Users::BulkPreferenceTopic::status
+
+        attr_accessor topic_id: String
+
+        def initialize: (
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        ) -> void
+
+        def to_hash: -> {
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        }
+
+        type status = :OPTED_IN | :OPTED_OUT
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          OPTED_IN: :OPTED_IN
+          OPTED_OUT: :OPTED_OUT
+
+          def self?.values: -> ::Array[Courier::Models::Users::BulkPreferenceTopic::status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_replace_params.rbs

@@ -0,0 +1,87 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_replace_params =
+        {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          tenant_id: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class PreferenceBulkReplaceParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic]
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          tenant_id: String?,
+          request_options: Courier::RequestOptions
+        }
+
+        type topic =
+          {
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+        class Topic < Courier::Internal::Type::BaseModel
+          attr_accessor status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status
+
+          attr_accessor topic_id: String
+
+          attr_reader custom_routing: ::Array[Courier::Models::channel_classification]?
+
+          def custom_routing=: (
+            ::Array[Courier::Models::channel_classification]
+          ) -> ::Array[Courier::Models::channel_classification]
+
+          attr_reader has_custom_routing: bool?
+
+          def has_custom_routing=: (bool) -> bool
+
+          def initialize: (
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            ?custom_routing: ::Array[Courier::Models::channel_classification],
+            ?has_custom_routing: bool
+          ) -> void
+
+          def to_hash: -> {
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+          type status = :OPTED_IN | :OPTED_OUT
+
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN: :OPTED_IN
+            OPTED_OUT: :OPTED_OUT
+
+            def self?.values: -> ::Array[Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_replace_response.rbs

@@ -0,0 +1,27 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_replace_response =
+        {
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+      class PreferenceBulkReplaceResponse < Courier::Internal::Type::BaseModel
+        attr_accessor deleted: ::Array[String]
+
+        attr_accessor items: ::Array[Courier::Users::BulkPreferenceTopic]
+
+        def initialize: (
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        ) -> void
+
+        def to_hash: -> {
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_update_params.rbs

@@ -0,0 +1,87 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_update_params =
+        {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          tenant_id: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class PreferenceBulkUpdateParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic]
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          tenant_id: String?,
+          request_options: Courier::RequestOptions
+        }
+
+        type topic =
+          {
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+        class Topic < Courier::Internal::Type::BaseModel
+          attr_accessor status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status
+
+          attr_accessor topic_id: String
+
+          attr_reader custom_routing: ::Array[Courier::Models::channel_classification]?
+
+          def custom_routing=: (
+            ::Array[Courier::Models::channel_classification]
+          ) -> ::Array[Courier::Models::channel_classification]
+
+          attr_reader has_custom_routing: bool?
+
+          def has_custom_routing=: (bool) -> bool
+
+          def initialize: (
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            ?custom_routing: ::Array[Courier::Models::channel_classification],
+            ?has_custom_routing: bool
+          ) -> void
+
+          def to_hash: -> {
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+          type status = :OPTED_IN | :OPTED_OUT
+
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN: :OPTED_IN
+            OPTED_OUT: :OPTED_OUT
+
+            def self?.values: -> ::Array[Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_update_response.rbs

@@ -0,0 +1,39 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_update_response =
+        {
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+      class PreferenceBulkUpdateResponse < Courier::Internal::Type::BaseModel
+        attr_accessor errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error]
+
+        attr_accessor items: ::Array[Courier::Users::BulkPreferenceTopic]
+
+        def initialize: (
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        ) -> void
+
+        def to_hash: -> {
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+        type error = { reason: String, topic_id: String }
+
+        class Error < Courier::Internal::Type::BaseModel
+          attr_accessor reason: String
+
+          attr_accessor topic_id: String
+
+          def initialize: (reason: String, topic_id: String) -> void
+
+          def to_hash: -> { reason: String, topic_id: String }
+        end
+      end
+    end
+  end
+end